wwan: T3620: rename "wirelessmodem wlm" interfaces to new wwan interface tree

7 files changed, 252 insertions, 134 deletions

diff --git a/src/conf_mode/interfaces-wirelessmodem.py b/src/conf_mode/interfaces-wirelessmodem.py
deleted file mode 100755
index 976953b31..000000000
--- a/src/conf_mode/interfaces-wirelessmodem.py
+++ /dev/null
@@ -1,132 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2020 VyOS maintainers and contributors
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 or later as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-
-from sys import exit
-
-from vyos.config import Config
-from vyos.configdict import get_interface_dict
-from vyos.configverify import verify_vrf
-from vyos.template import render
-from vyos.util import call
-from vyos.util import check_kmod
-from vyos.util import find_device_file
-from vyos import ConfigError
-from vyos import airbag
-airbag.enable()
-
-k_mod = ['option', 'usb_wwan', 'usbserial']
-
-def get_config(config=None):
-    """
-    Retrive CLI config as dictionary. Dictionary can never be empty, as at least the
-    interface name will be added or a deleted flag
-    """
-    if config:
-        conf = config
-    else:
-        conf = Config()
-    base = ['interfaces', 'wirelessmodem']
-    wwan = get_interface_dict(conf, base)
-
-    return wwan
-
-def verify(wwan):
-    if 'deleted' in wwan:
-        return None
-
-    if not 'apn' in wwan:
-        raise ConfigError('No APN configured for "{ifname}"'.format(**wwan))
-
-    if not 'device' in wwan:
-        raise ConfigError('Physical "device" must be configured')
-
-    # we can not use isfile() here as Linux device files are no regular files
-    # thus the check will return False
-    dev_path = find_device_file(wwan['device'])
-    if dev_path is None or not os.path.exists(dev_path):
-        raise ConfigError('Device "{device}" does not exist'.format(**wwan))
-
-    verify_vrf(wwan)
-
-    return None
-
-def generate(wwan):
-    # set up configuration file path variables where our templates will be
-    # rendered into
-    ifname = wwan['ifname']
-    config_wwan = f'/etc/ppp/peers/{ifname}'
-    config_wwan_chat = f'/etc/ppp/peers/chat.{ifname}'
-    script_wwan_pre_up = f'/etc/ppp/ip-pre-up.d/1010-vyos-wwan-{ifname}'
-    script_wwan_ip_up = f'/etc/ppp/ip-up.d/1010-vyos-wwan-{ifname}'
-    script_wwan_ip_down = f'/etc/ppp/ip-down.d/1010-vyos-wwan-{ifname}'
-
-    config_files = [config_wwan, config_wwan_chat, script_wwan_pre_up,
-                    script_wwan_ip_up, script_wwan_ip_down]
-
-    # Always hang-up WWAN connection prior generating new configuration file
-    call(f'systemctl stop ppp@{ifname}.service')
-
-    if 'deleted' in wwan:
-        # Delete PPP configuration files
-        for file in config_files:
-            if os.path.exists(file):
-                os.unlink(file)
-
-    else:
-        wwan['device'] = find_device_file(wwan['device'])
-
-        # Create PPP configuration files
-        render(config_wwan, 'wwan/peer.tmpl', wwan)
-        # Create PPP chat script
-        render(config_wwan_chat, 'wwan/chat.tmpl', wwan)
-
-        # generated script file must be executable
-
-        # Create script for ip-pre-up.d
-        render(script_wwan_pre_up, 'wwan/ip-pre-up.script.tmpl',
-               wwan, permission=0o755)
-        # Create script for ip-up.d
-        render(script_wwan_ip_up, 'wwan/ip-up.script.tmpl',
-               wwan, permission=0o755)
-        # Create script for ip-down.d
-        render(script_wwan_ip_down, 'wwan/ip-down.script.tmpl',
-               wwan, permission=0o755)
-
-    return None
-
-def apply(wwan):
-    if 'deleted' in wwan:
-        # bail out early
-        return None
-
-    if not 'disable' in wwan:
-        # "dial" WWAN connection
-        call('systemctl start ppp@{ifname}.service'.format(**wwan))
-
-    return None
-
-if __name__ == '__main__':
-    try:
-        check_kmod(k_mod)
-        c = get_config()
-        verify(c)
-        generate(c)
-        apply(c)
-    except ConfigError as e:
-        print(e)
-        exit(1)
diff --git a/src/conf_mode/interfaces-wwan.py b/src/conf_mode/interfaces-wwan.py
new file mode 100755
index 000000000..02d2c723d
--- /dev/null
+++ b/src/conf_mode/interfaces-wwan.py
@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020-2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from sys import exit
+
+from vyos.config import Config
+from vyos.configdict import get_interface_dict
+from vyos.configverify import verify_interface_exists
+from vyos.configverify import verify_vrf
+from vyos.ifconfig import WWANIf
+from vyos.util import cmd
+from vyos.template import render
+from vyos import ConfigError
+from vyos import airbag
+airbag.enable()
+
+def get_config(config=None):
+    """
+    Retrive CLI config as dictionary. Dictionary can never be empty, as at least the
+    interface name will be added or a deleted flag
+    """
+    if config:
+        conf = config
+    else:
+        conf = Config()
+    base = ['interfaces', 'wwan']
+    wwan = get_interface_dict(conf, base)
+
+    return wwan
+
+def verify(wwan):
+    if 'deleted' in wwan:
+        return None
+
+    ifname = wwan['ifname']
+    if not 'apn' in wwan:
+        raise ConfigError(f'No APN configured for "{ifname}"!')
+
+    verify_interface_exists(ifname)
+    verify_vrf(wwan)
+
+    return None
+
+def generate(wwan):
+    return None
+
+def apply(wwan):
+    # we only need the modem number. wwan0 -> 0, wwan1 -> 1
+    modem = wwan['ifname'].replace('wwan','')
+    base_cmd = f'mmcli --modem {modem}'
+
+    w = WWANIf(wwan['ifname'])
+    if 'deleted' in wwan or 'disable' in wwan:
+        w.remove()
+        cmd(f'{base_cmd} --simple-disconnect')
+        return None
+
+    cmd(f'{base_cmd} --simple-connect=\"apn={wwan["apn"]}\"')
+    w.update(wwan)
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/etc/systemd/system/ModemManager.service.d/override.conf b/src/etc/systemd/system/ModemManager.service.d/override.conf
new file mode 100644
index 000000000..07a18460e
--- /dev/null
+++ b/src/etc/systemd/system/ModemManager.service.d/override.conf
@@ -0,0 +1,7 @@
+[Unit]
+After=
+After=vyos-router.service
+
+[Service]
+ExecStart=
+ExecStart=/usr/sbin/ModemManager --filter-policy=strict --log-level=INFO --log-timestamps --log-journal
diff --git a/src/migration-scripts/interfaces/21-to-22 b/src/migration-scripts/interfaces/21-to-22
new file mode 100755
index 000000000..03b990afb
--- /dev/null
+++ b/src/migration-scripts/interfaces/21-to-22
@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from sys import argv
+from sys import exit
+
+from vyos.configtree import ConfigTree
+
+if __name__ == '__main__':
+    if (len(argv) < 1):
+        print("Must specify file name!")
+        exit(1)
+
+    file_name = argv[1]
+
+    with open(file_name, 'r') as f:
+        config_file = f.read()
+
+    config = ConfigTree(config_file)
+    base = ['interfaces', 'wirelessmodem']
+    if not config.exists(base):
+        # Nothing to do
+        exit(0)
+
+    new_base = ['interfaces', 'wwan']
+    config.set(new_base)
+    config.set_tag(new_base)
+    for interface in config.list_nodes(base):
+        # convert usb0b1.3p1.2 device identifier and extract 1.3 usb bus id
+        usb = config.return_value(base + [interface, 'device'])
+        device = usb.split('b')[-1]
+        busid = device.split('p')[0]
+        for wwan in os.listdir('/sys/class/net'):
+            # we are only interested in interfaces starting with wwan
+            if not wwan.startswith('wwan'):
+                continue
+            device = os.readlink(f'/sys/class/net/{wwan}/device')
+            device = device.split(':')[0]
+            if busid in device:
+                config.copy(base + [interface], new_base + [wwan])
+
+    config.delete(base)
+
+    # Now that we have copied the old wirelessmodem interfaces to wwan
+    # we can start to migrate also individual config items.
+    for interface in config.list_nodes(new_base):
+        # we do no longer need the USB device name
+        config.delete(new_base + [interface, 'device'])
+        # set/unset DNS configuration
+        dns = new_base + [interface, 'no-peer-dns']
+        if config.exists(dns):
+            config.delete(dns)
+        else:
+            config.set(['system', 'name-servers-dhcp'], value=interface, replace=False)
+
+        # the new wwan interface use regular IP addressing
+        config.set(new_base + [interface, 'address'], value='dhcp')
+
+    try:
+        with open(file_name, 'w') as f:
+            f.write(config.to_string())
+    except OSError as e:
+        print("Failed to save the modified config: {}".format(e))
+        exit(1)
diff --git a/src/op_mode/show_wwan.py b/src/op_mode/show_wwan.py
new file mode 100755
index 000000000..249dda2a5
--- /dev/null
+++ b/src/op_mode/show_wwan.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import argparse
+
+from sys import exit
+from vyos.util import cmd
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--model", help="Get module model", action="store_true")
+parser.add_argument("--revision", help="Get module revision", action="store_true")
+parser.add_argument("--capabilities", help="Get module capabilities", action="store_true")
+parser.add_argument("--imei", help="Get module IMEI/ESN/MEID", action="store_true")
+parser.add_argument("--imsi", help="Get module IMSI", action="store_true")
+parser.add_argument("--msisdn", help="Get module MSISDN", action="store_true")
+parser.add_argument("--sim", help="Get SIM card status", action="store_true")
+parser.add_argument("--signal", help="Get current RF signal info", action="store_true")
+parser.add_argument("--firmware", help="Get current RF signal info", action="store_true")
+
+required = parser.add_argument_group('Required arguments')
+required.add_argument("--interface", help="WWAN interface name, e.g. wwan0", required=True)
+
+def qmi_cmd(device, command, silent=False):
+    tmp = cmd(f'qmicli --device={device} --device-open-proxy {command}')
+    tmp = tmp.replace(f'[{cdc}] ', '')
+    if not silent:
+        # skip first line as this only holds the info headline
+        for line in tmp.splitlines()[1:]:
+            print(line.lstrip())
+    return tmp
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+
+    # remove the WWAN prefix from the interface, required for the CDC interface
+    if_num = args.interface.replace('wwan','')
+    cdc = f'/dev/cdc-wdm{if_num}'
+
+    if args.model:
+        qmi_cmd(cdc, '--dms-get-model')
+    elif args.capabilities:
+        qmi_cmd(cdc, '--dms-get-capabilities')
+        qmi_cmd(cdc, '--dms-get-band-capabilities')
+    elif args.revision:
+        qmi_cmd(cdc, '--dms-get-revision')
+    elif args.imei:
+        qmi_cmd(cdc, '--dms-get-ids')
+    elif args.imsi:
+        qmi_cmd(cdc, '--dms-uim-get-imsi')
+    elif args.msisdn:
+        qmi_cmd(cdc, '--dms-get-msisdn')
+    elif args.sim:
+        qmi_cmd(cdc, '--uim-get-card-status')
+    elif args.signal:
+        qmi_cmd(cdc, '--nas-get-signal-info')
+        qmi_cmd(cdc, '--nas-get-rf-band-info')
+    elif args.firmware:
+        tmp = qmi_cmd(cdc, '--dms-get-manufacturer', silent=True)
+        if 'Sierra Wireless' in tmp:
+            qmi_cmd(cdc, '--dms-swi-get-current-firmware')
+        else:
+            qmi_cmd(cdc, '--dms-get-software-version')
+    else:
+        parser.print_help()
+        exit(1)
diff --git a/src/validators/interface-name b/src/validators/interface-name
index 5bac671b1..105815eee 100755
--- a/src/validators/interface-name
+++ b/src/validators/interface-name
@@ -20,7 +20,7 @@ import re
 from sys import argv
 from sys import exit
 
-pattern = '^(bond|br|dum|en|ersp|eth|gnv|lan|l2tp|l2tpeth|macsec|peth|ppp|pppoe|pptp|sstp|tun|vti|vtun|vxlan|wg|wlan|wlm)[0-9]+(.\d+)?|lo$'
+pattern = '^(bond|br|dum|en|ersp|eth|gnv|lan|l2tp|l2tpeth|macsec|peth|ppp|pppoe|pptp|sstp|tun|vti|vtun|vxlan|wg|wlan|wwan)[0-9]+(.\d+)?|lo$'
 
 if __name__ == '__main__':
     if len(argv) != 2:
diff --git a/src/validators/vrf-name b/src/validators/vrf-name
index 7b6313888..c78a80776 100755
--- a/src/validators/vrf-name
+++ b/src/validators/vrf-name
@@ -34,7 +34,7 @@ if __name__ == '__main__':
         exit(1)
 
     pattern = "^(?!(bond|br|dum|eth|lan|eno|ens|enp|enx|gnv|ipoe|l2tp|l2tpeth|" \
-              "vtun|ppp|pppoe|peth|tun|vti|vxlan|wg|wlan|wlm)\d+(\.\d+(v.+)?)?$).*$"
+              "vtun|ppp|pppoe|peth|tun|vti|vxlan|wg|wlan|wwan)\d+(\.\d+(v.+)?)?$).*$"
     if not re.match(pattern, vrf):
         exit(1)