Merge pull request #3415 from BsAtHome/backport_2.9_fix_modcompile

Backport: fix modcompile issues

Author: BsAtHome

docs/man/man1/modcompile.1

@@ -26,14 +26,38 @@
 .SH NAME
 modcompile \- Utility for compiling Modbus drivers
 
+.SH SYNOPSIS
+
+\fBmodcompile -h\fR
+
+\fBmodcompile* [\fB-k\fR] [\fB-n\fR] [\fB-v\fR] all
+
+\fBmodcompile* [\fB-k\fR] [\fB-n\fR] [\fB-v\fR] module.mod ...
+
 .SH DESCRIPTION
-\fBmodcompile\fR is used to compile modbus drivers that use the Mesa
-card UARTs. 
+The \fBmodcompile\fR utility is used to compile modbus drivers that use the PktUART
+interface of Mesa cards.
 
 See the main LinuxCNC documentation for more details. 
 
 http://linuxcnc.org/docs/stable/html/drivers/mesa_modbus.html
-.
+
+.SH OPTIONS
+.TP
+\fB-h\fR, \fB--help\fR
+Brief help message.
+.TP
+\fB-k\fR, \fB--keep\fR
+Keep the temporary files. The program will print a line where these are
+located. You will be responsible for deleting them.
+.TP
+\fB-n\fR, \fB--noinstall\fR
+Do not run the install step for the compiled module. This option is probably
+only useful if you also use the \fB--keep\fR option.
+.TP
+\fB-v\fR, \fB--verbose\fR
+Do a verbose build, showing all steps detailed while being performed.
+
 .SH "SEE ALSO"
 \fBLinuxCNC(1)\fR
 

src/hal/drivers/mesa-hostmot2/modbus/analogue.mod

@@ -23,3 +23,5 @@ static const hm2_modbus_chan_descriptor_t channels[] = {
    internal workings. 1 is default (errors only)                    */
 
 #define DEBUG 1
+
+// vim: syn=c

src/hal/drivers/mesa-hostmot2/modbus/mesa_modbus.c.tmpl

@@ -48,7 +48,7 @@ static const char *error_codes[]={
     "Server Device Busy",
     "Negative Acknowledge",
     "Memory Parity Error",
-    "Unknown exception code 9"
+    "Unknown exception code 9",
     "Gateway Path Unavailable",
     "Gateway Failed to Respond",
     "Comm Timeout"
@@ -894,4 +894,4 @@ static uint16_t RTU_CRC(rtapi_u8* buf, int len){
   return crc;  
 }
 
-// vim: syn=c
+// vim: syn=c ts=4

src/hal/drivers/mesa-hostmot2/modbus/mesa_modbus.mod.sample

@@ -29,3 +29,5 @@ static const hm2_modbus_chan_descriptor_t channels[] = {
 // Create 7 scaled FP HAL pins to control holfing registers at 0x400-0x406
     {HAL_FLOAT, 16,  0x0300, 1,     "more_floats"},
 };
+
+// vim: syn=c

src/hal/drivers/mesa-hostmot2/modbus/modcompile.py

@@ -23,19 +23,23 @@
 import sys
 import os
 import tempfile
+import getopt
+import shutil
 
-
-def usage(exitval=0):
+def usage():
     print("""Build and install Modbus components that use the Mesa PktUART
-
 Usage:
-          modcompile device.mod  Compile and install a driver defined in
-                                 device.h
-          modcompile all         Compile and install all definition files
-                                 in this directory.
-
+  modcompile [opts] device.mod...  Compile and install a driver defined in
+                                   device.mod
+  modcompile [opts] all            Compile and install all .mod definition
+                                   files in this directory.
+Options:
+  -h|--help       This message
+  -k|--keep       Keep temporary files
+  -n|--noinstall  Don't perform the install step
+  -v|--verbose    Verbose compile
 """)
-    raise SystemExit(exitval)
+    sys.exit(2)
 
 modinc = None
 def find_modinc():
@@ -49,31 +53,70 @@ def find_modinc():
             return e
     raise SystemExit("Unable to locate Makefile.modinc")
 
-if len(sys.argv) < 2:
-    usage(0)
-
-if sys.argv[1] == "all":
-    names = [f for f in os.listdir(".") if f.endswith(".mod")]
-else:
-    names = [sys.argv[1]]
-
-tempdir = tempfile.mkdtemp()
-BASE = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), ".."))
-print(os.path.join(tempdir, "mesa_modbus.c"))
-os.symlink(os.path.join(BASE, "share", "linuxcnc", "mesa_modbus.c.tmpl"), os.path.join(tempdir, "mesa_modbus.c"))
-for f in names:
-    b = os.path.splitext(os.path.basename(f))[0]
-    # The module definition is #included as mesa_modbus.h
-    m = open(os.path.join(tempdir, "Makefile"), "w")
-    print("obj-m += %s.o" % b,file=m)
-    print("%s-objs:=mesa_modbus.o" % b,file=m)
-    print("include %s" % find_modinc(), file=m)
-    print("EXTRA_CFLAGS += -I%s" % tempdir, file=m)
-    print("EXTRA_CFLAGS += -DMODFILE=%s" % os.path.abspath(f), file=m)
-    print("EXTRA_CFLAGS += -D_COMP_NAME_=%s" % b, file=m)
-    m.close()
-    os.system("touch mesa_modbus.c") # Force a recompile
-    result = os.system("cd %s && make -S modules install" % tempdir)
-
-    if result != 0:
-        raise SystemExit(os.WEXITSTATUS(result) or 1)
+def main():
+    # Get the command-line options
+    try:
+        opts, args = getopt.getopt(sys.argv[1:], "hklnv", ["help", "keep", "noinstall", "verbose"])
+    except getopt.GetoptError as err:
+        raise SystemExit(err)  # Something like "option -a not recognized"
+
+    # Check the options
+    verbose = ""
+    install = " install"
+    keep = False
+    for o, a in opts:
+        if o in ("-v", "--verbose"):
+            verbose = " V=1"
+        elif o in ("-n", "--noinstall"):
+            install = ""
+        elif o in ("-k", "--keep"):
+            keep = True
+        elif o in ("-h", "--help"):
+            usage()
+        else:
+            raise SystemExit("Unhandled option: '%s'" % o);
+
+    if len(args) < 1:
+        raise SystemExit("Must have at least one 'file.mod' argument or 'all' for all.");
+
+    if len(args) > 1 and "all" in args:
+        raise SystemExit("Cannot do both 'all' modules and specific modules.");
+    if args[0] == "all":
+        args = [f for f in os.listdir(".") if f.endswith(".mod")]
+    # 'args' now contains all modules to compile
+
+    if len(args) < 1:
+        raise SystemExit("No modules found (*.mod files) to compile.");
+
+    # Create a temporary directory and copy the C template into it
+    tempdir = tempfile.mkdtemp(prefix="modcompile")
+    BASE = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), ".."))
+    csrc = os.path.join(tempdir, "mesa_modbus.c")
+    if verbose:
+        print(csrc)
+    shutil.copy(os.path.join(BASE, "share", "linuxcnc", "mesa_modbus.c.tmpl"), csrc)
+
+    # For each module to compile...
+    for f in args:
+        modname = os.path.splitext(os.path.basename(f))[0]
+        # The module definition is #included as mesa_modbus.h
+        m = open(os.path.join(tempdir, "Makefile"), "w")
+        print("obj-m += %s.o" % modname, file=m)
+        print("%s-objs:=mesa_modbus.o" % modname, file=m)
+        print("include %s" % find_modinc(), file=m)
+        print("EXTRA_CFLAGS += -I%s" % tempdir, file=m)
+        print("EXTRA_CFLAGS += -DMODFILE=%s" % os.path.abspath(f), file=m)
+        print("EXTRA_CFLAGS += -D_COMP_NAME_=%s" % modname, file=m)
+        m.close()
+        result = os.system("cd %s && make -B -S modules %s%s" % (tempdir, install, verbose))
+        if result != 0:
+            raise SystemExit(os.WEXITSTATUS(result) or 1)
+
+    # Cleanup step
+    if keep:
+        print("Sources and build files kept in: %s" % tempdir)
+    else:
+        shutil.rmtree(tempdir)
+
+if __name__ == "__main__":
+    main()

src/hal/drivers/mesa-hostmot2/modbus/relayboard.mod

@@ -27,3 +27,4 @@ static const hm2_modbus_chan_descriptor_t channels[] = {
    Use 3 to see a lot of information about the modbus
    internal workings. 1 is default (errors only)                    */
 
+// vim: syn=c