]> sigrok.org Git - sigrok-util.git/blobdiff - source/new-driver
new-driver: Update to match recent drivers API changes.
[sigrok-util.git] / source / new-driver
index 2f8d5a07bb1bf0e918c5b8c6cf56882880628de0..6d77220fc9ad41128525dbd6b21e9ecc117e9630 100755 (executable)
@@ -27,36 +27,26 @@ import re
 import socket
 import datetime
 
-TMPL_AUTOCONF_AC_ARG_ENABLE = """\
-AC_ARG_ENABLE(${short}, AC_HELP_STRING([--enable-${short}],
-       [enable ${name} support [default=yes]]),
-       [HW_${upper}="$enableval"],
-       [HW_${upper}=$HW_ENABLED_DEFAULT])
-AM_CONDITIONAL(HW_${upper}, test x$HW_${upper} = xyes)
-if test "x$HW_${upper}" = "xyes"; then
-       AC_DEFINE(HAVE_HW_${upper}, 1, [${name} support])
-fi
+TMPL_AUTOCONF_DRIVER = "DRIVER([${name}], [${short}])\n"
+TMPL_AUTOCONF_DRIVER2 = "DRIVER2([HW_${upper}], [$HW_${upper}], [HAVE_HW_${upper}])\n"
 
-"""
-TMPL_AUTOCONF_AC_CONFIG_FILES = "\t\t hardware/${short}/Makefile\n"
-TMPL_AUTOCONF_SUMMARY = 'echo "  - ${summary}"\n'
-TMPL_HWMAKE_SUBDIR = '\t${short}'
 TMPL_HWMAKE_DRIVERLIB = """if HW_${upper}
-libsigrokhardware_la_LIBADD += ${short}/libsigrok_hw_${lib}.la
+libsigrok_la_SOURCES += \\
+       src/hardware/${short}/protocol.h \\
+       src/hardware/${short}/protocol.c \\
+       src/hardware/${short}/api.c
 endif
-
 """
-TMPL_HWDRIVER_EXTERN = """\
+TMPL_DRIVERS_EXTERN = """\
 #ifdef HAVE_HW_${upper}
 extern SR_PRIV struct sr_dev_driver ${lib}_driver_info;
 #endif
 """
-TMPL_HWDRIVER_DIPTR = """\
+TMPL_DRIVERS_POINTER = """\
 #ifdef HAVE_HW_${upper}
-       &${lib}_driver_info,
+       (DRVS) {&${lib}_driver_info, NULL},
 #endif
 """
-FILE_DRV_MAKEFILE = 'drv-Makefile.am'
 FILE_DRV_API = 'drv-api.c'
 FILE_DRV_PROTOCOL = 'drv-protocol.c'
 FILE_DRV_PROTOCOL_H = 'drv-protocol.h'
@@ -77,14 +67,14 @@ def new_driver():
     tmp = tempfile.mkdtemp()
     try:
         os.chdir(tmp)
-        process = Popen("git clone " + LIBSR, shell=True, stderr=PIPE)
+        process = Popen("git clone --depth=1 " + LIBSR, shell=True, stderr=PIPE)
         out, err = process.communicate()
         if process.returncode:
             raise Exception(err.decode())
         gitdir = tmp + '/libsigrok/'
-        do_configure_ac(gitdir)
-        do_hwdriver(gitdir)
-        do_hwmake(gitdir)
+        do_autoconf(gitdir)
+        do_drivers(gitdir)
+        do_automake(gitdir)
         do_driverskel(gitdir)
         make_patch(gitdir)
     except Exception as e:
@@ -92,164 +82,111 @@ def new_driver():
     shutil.rmtree(tmp)
 
 
-def do_configure_ac(gitdir):
+# add DRIVER and DRIVER2 entries to configure.ac
+def do_autoconf(gitdir):
     cacpath = gitdir + 'configure.ac'
     configure_ac = open(cacpath).read()
 
-    # add AC_ARG_ENABLE option
     out = ''
-    state = 'copy'
+    state = 'driver'
+    active = False
     for line in configure_ac.split('\n')[:-1]:
-        if state == 'copy':
-            if line == "# Hardware support '--enable' options.":
-                state = 'acarg'
-        elif state == 'acarg':
-            m = re.match('AC_ARG_ENABLE\(([^,]+)', line)
+        if state == 'driver':
+            m = re.match('DRIVER\(\[([^\]]+)', line)
             if m:
-                drv_short = m.group(1)
-                if drv_short.lower() > names['short']:
-                    out += tmpl(TMPL_AUTOCONF_AC_ARG_ENABLE)
-                    state = 'done'
-            if line == '# Checks for libraries.':
-                # new one at the end
-                out += tmpl(TMPL_AUTOCONF_AC_ARG_ENABLE)
-                state = 'done'
-        out += line + '\n'
-    if state != 'done':
-        raise Exception('AC_ARG_ENABLE markers not found in configure.ac')
-    configure_ac = out
-
-    # add driver Makefile to AC_CONFIG_FILES
-    out = ''
-    state = 'copy'
-    for line in configure_ac.split('\n')[:-1]:
-        if state == 'copy':
-            if line.find("AC_CONFIG_FILES([Makefile") > -1:
-                state = 'acconf'
-        elif state == 'acconf':
-            m = re.match('\t\t hardware/([^/]+)/Makefile', line)
+                active = True
+            if active:
+                if (m and m.group(1).upper() > names['name'].upper()) or m is None:
+                    out += tmpl(TMPL_AUTOCONF_DRIVER)
+                    state = 'automake'
+                    active = False
+        elif state == 'automake':
+            m = re.match('DRIVER2\(\[([^\]]+)', line)
             if m:
-                drv_short = m.group(1)
-                if drv_short.lower() > names['short']:
-                    out += tmpl(TMPL_AUTOCONF_AC_CONFIG_FILES)
-                    state = 'done'
+                active = True
             else:
-                # new one at the end
-                out += tmpl(TMPL_AUTOCONF_AC_CONFIG_FILES)
-                state = 'done'
-        out += line + '\n'
-    if state != 'done':
-        raise Exception('AC_CONFIG_FILES marker not found in configure.ac')
-    configure_ac = out
-
-    # add summary line
-    out = ''
-    state = 'copy'
-    names['summary'] = "%s%s $HW_%s" % (names['short'],
-            '.' * (32 - len(names['name'])), names['upper'])
-    for line in configure_ac.split('\n')[:-1]:
-        if state == 'copy':
-            if line.find('Enabled hardware drivers') > -1:
-                state = 'echo'
-        elif state == 'echo':
-            m = re.match('echo "  - ([^\.]+)', line)
-            if m:
-                drv_short = m.group(1)
-                if drv_short.lower() > names['name'].lower():
-                    out += tmpl(TMPL_AUTOCONF_SUMMARY)
+                submatch = re.match('DRIVER2\(\[([^\]]+)', line)
+                if active and submatch is None:
+                    # we're past the DRIVER2 list
+                    out += tmpl(TMPL_AUTOCONF_DRIVER2)
+                    state = 'done'
+            if active:
+                if (m and m.group(1) > 'HW_' + names['upper']):
+                    out += tmpl(TMPL_AUTOCONF_DRIVER2)
                     state = 'done'
-            else:
-                # new one at the end
-                out += tmpl(TMPL_AUTOCONF_SUMMARY)
-                state = 'done'
         out += line + '\n'
     if state != 'done':
-        raise Exception('summary marker not found in configure.ac')
-    configure_ac = out
-
-    open(cacpath, 'w').write(configure_ac)
+        raise Exception('No DRIVER entries found in configure.ac')
+    open(cacpath, 'w').write(out)
 
 
-def do_hwdriver(gitdir):
-    path = gitdir + 'hwdriver.c'
-    hwdriver = open(path).read()
-    # add HAVE_HW_thing extern and pointers
+# add HAVE_HW_ extern and pointers to drivers.c
+def do_drivers(gitdir):
+    path = gitdir + 'src/drivers.c'
+    source = open(path).read()
     out = ''
-    state = 'copy'
-    for line in hwdriver.split('\n')[:-1]:
-        if state == 'copy':
-            if line.find('/** @cond PRIVATE */') == 0:
-                state = 'extern'
-            elif line.find('static struct sr_dev_driver *drivers_list') == 0:
-                state = 'diptr'
-        elif state in ('extern', 'diptr'):
+    state = 'extern'
+    first_entry = ''
+    for line in source.split('\n')[:-1]:
+        m = re.match('#ifdef HAVE_HW_(.*)', line)
+        if m:
+            if not first_entry:
+                first_entry = m.group(1)
+            elif m.group(1) == first_entry:
+                # second time we see this, so we're past the externs
+                if state != 'idle':
+                    # tack driver on to the end of the list
+                    out += tmpl(TMPL_DRIVERS_EXTERN)
+                state = 'pointer'
             if state == 'extern':
-                entry = tmpl(TMPL_HWDRIVER_EXTERN)
-                next_state = 'copy'
-            else:
-                entry = tmpl(TMPL_HWDRIVER_DIPTR)
-                next_state = 'done'
-            m = re.match('#ifdef HAVE_.._(.*)', line)
-            if m:
-                drv = m.group(1)
-                if drv > names['upper']:
-                    out += entry
-                    state = next_state
-            elif not re.match('(extern|\t&|#endif)', line):
-                # new one at the end
-                out += entry
-                state = next_state
+                if m.group(1) > names['upper']:
+                    out += tmpl(TMPL_DRIVERS_EXTERN)
+                    state = 'idle'
+            elif state == 'pointer':
+                if m.group(1) > names['upper']:
+                    out += tmpl(TMPL_DRIVERS_POINTER)
+                    state = 'done'
+        elif state == 'pointer' and not re.match('(\s*&|#endif|$)', line):
+            # we passed the last entry
+            out += tmpl(TMPL_DRIVERS_POINTER)
+            state = 'done'
         out += line + '\n'
     if state != 'done':
-        raise Exception('HAVE_* markers not found in hwdriver.c')
-    hwdriver = out
-
-    open(path, 'w').write(hwdriver)
+        raise Exception('No "HAVE_HW_*" markers found in drivers.c' + state)
+    open(path, 'w').write(out)
 
 
-def do_hwmake(gitdir):
-    path = gitdir + 'hardware/Makefile.am'
+# add HW_ entry to Makefile.am
+def do_automake(gitdir):
+    path = gitdir + 'Makefile.am'
     hwmake = open(path).read()
 
-    # add SUBDIRS entry
     out = ''
     state = 'copy'
     for line in hwmake.split('\n')[:-1]:
-        if state == 'copy':
-            if line.find('SUBDIRS =') > -1:
-                state = 'subdirs'
-        elif state == 'subdirs':
-            m = re.match('\t([^ \\\]+\s*\\\)', line)
-            if m:
-                drv_short = m.group(1)
-                if drv_short.lower() > names['short']:
-                    out += tmpl(TMPL_HWMAKE_SUBDIR) + ' \\\n'
-                    state = 'driverlib'
-            else:
-                out += tmpl(TMPL_HWMAKE_SUBDIR) + ' \\\n'
-                state = 'driverlib'
-        elif state == 'driverlib':
-            m = re.match('if [A-Z]{2}_(.*)$', line)
+        if state == 'copy' and re.match('if HW_(.*)$', line):
+            state = 'drivers'
+        if state == 'drivers':
+            m = re.match('if HW_(.*)$', line)
             if m:
                 drv_short = m.group(1)
                 if drv_short > names['upper']:
                     out += tmpl(TMPL_HWMAKE_DRIVERLIB)
                     state = 'done'
+            elif not re.match('(libsigrok_la_SOURCES|\s*src/hardware/|endif)', line):
+                print("[%s]" % line.strip())
+                # we passed the last entry
+                out += tmpl(TMPL_HWMAKE_DRIVERLIB)
+                state = 'done'
         out += line + '\n'
-    if state == 'driverlib':
-        # reached end of file, add it in here
-        out += tmpl(TMPL_HWMAKE_DRIVERLIB).strip()
-    elif state != 'done':
-        raise Exception('markers not found in hardware/Makefile.am')
-    hwmake = out
-
-    open(path, 'w').write(hwmake)
+    if state != 'done':
+        raise Exception('No "if HW_" markers found in Makefile.am')
+    open(path, 'w').write(out)
 
 
 def do_driverskel(gitdir):
-    drvdir = gitdir + 'hardware/' + names['short']
+    drvdir = gitdir + 'src/hardware/' + names['short']
     os.mkdir(drvdir)
-    open(drvdir + '/Makefile.am', 'w').write(tmpl_file(FILE_DRV_MAKEFILE))
     open(drvdir + '/api.c', 'w').write(tmpl_file(FILE_DRV_API))
     open(drvdir + '/protocol.c', 'w').write(tmpl_file(FILE_DRV_PROTOCOL))
     open(drvdir + '/protocol.h', 'w').write(tmpl_file(FILE_DRV_PROTOCOL_H))
@@ -257,9 +194,9 @@ def do_driverskel(gitdir):
 
 def make_patch(gitdir):
     os.chdir(gitdir)
-    command('git add hardware/' + names['short'])
+    command('git add src/hardware/' + names['short'])
     cmd = 'git commit -m "%s: Initial driver skeleton." ' % names['short']
-    cmd += 'configure.ac hwdriver.c hardware/Makefile.am hardware/' + names['short']
+    cmd += 'configure.ac Makefile.am src/drivers.c src/hardware/' + names['short']
     command(cmd)
     cmd = "git format-patch HEAD~1"
     out, err = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE).communicate()