From 92781ecc7f96ca997803d41ece6f8c33e8e3326d Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Tue, 19 Nov 2019 13:52:28 +0100
Subject: [PATCH 1/5] modemmanager: add default proto configs

Signed-off-by: Aleksander Morgado <aleksander@aleksander.es>
---
 net/modemmanager/Makefile                 | 2 +-
 net/modemmanager/files/modemmanager.proto | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index d617cc022..166fa6365 100644
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=modemmanager
 PKG_VERSION:=1.12.0
-PKG_RELEASE:=3
+PKG_RELEASE:=4
 
 PKG_SOURCE:=ModemManager-$(PKG_VERSION).tar.xz
 PKG_SOURCE_URL:=https://www.freedesktop.org/software/ModemManager
diff --git a/net/modemmanager/files/modemmanager.proto b/net/modemmanager/files/modemmanager.proto
index 94cf0abce..7fb589c78 100755
--- a/net/modemmanager/files/modemmanager.proto
+++ b/net/modemmanager/files/modemmanager.proto
@@ -311,6 +311,7 @@ proto_modemmanager_init_config() {
 	proto_config_add_string	 pincode
 	proto_config_add_string	 iptype
 	proto_config_add_boolean lowpower
+	proto_config_add_defaults
 }
 
 proto_modemmanager_setup() {

From cc4ee2fd3c7ce84ec90c60778caf46bf4342f7d0 Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Tue, 19 Nov 2019 13:54:50 +0100
Subject: [PATCH 2/5] modemmanager: flag as available and no_device when
 initializing

Otherwise, if the modem is reseted, netifd will think that the device
is gone forever.

Signed-off-by: Aleksander Morgado <aleksander@aleksander.es>
---
 net/modemmanager/Makefile                 | 2 +-
 net/modemmanager/files/modemmanager.proto | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index 166fa6365..952f7c3e7 100644
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=modemmanager
 PKG_VERSION:=1.12.0
-PKG_RELEASE:=4
+PKG_RELEASE:=5
 
 PKG_SOURCE:=ModemManager-$(PKG_VERSION).tar.xz
 PKG_SOURCE_URL:=https://www.freedesktop.org/software/ModemManager
diff --git a/net/modemmanager/files/modemmanager.proto b/net/modemmanager/files/modemmanager.proto
index 7fb589c78..b7d99f41d 100755
--- a/net/modemmanager/files/modemmanager.proto
+++ b/net/modemmanager/files/modemmanager.proto
@@ -304,6 +304,8 @@ modemmanager_disconnected_method_common() {
 }
 
 proto_modemmanager_init_config() {
+	available=1
+	no_device=1
 	proto_config_add_string	 "device:device"
 	proto_config_add_string	 apn
 	proto_config_add_string	 username

From a684cdbab0495e133e9155f33a16c866986187cf Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Wed, 20 Nov 2019 12:49:11 +0100
Subject: [PATCH 3/5] modemmanager: fix device unplug handling

When a USB modem device is unplugged, we had to do two different
things: first, cleanup the sysfs cache; and second, set interface as
unavailable.

Those two things were never being done properly due to several
different issues:

 * The parent sysfs path retrieval logic relies on checking for which
 sysfs path has the vid/pid files. This logic obviously only works
 when the device is available, and cannot be used on e.g. removal
 events.

 * The command to cleanup the modem wait status from the sysfs cache
 was not removing the previous state properly, because the sysfs path
 variable wasn't escaped properly for the sed command.

This patch handles those issues in order to have a proper device
removal handling, by making sure the sysfs path is properly escaped in
the sed command, and by introducing a new hotplug script that runs
when the full USB device is removed.

Signed-off-by: Aleksander Morgado <aleksander@aleksander.es>
---
 net/modemmanager/Makefile                  |   5 +-
 net/modemmanager/files/25-modemmanager-usb |  13 +++
 net/modemmanager/files/modemmanager.common | 103 +++++++++++----------
 3 files changed, 70 insertions(+), 51 deletions(-)
 create mode 100644 net/modemmanager/files/25-modemmanager-usb

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index 952f7c3e7..0c73a8880 100644
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=modemmanager
 PKG_VERSION:=1.12.0
-PKG_RELEASE:=5
+PKG_RELEASE:=6
 
 PKG_SOURCE:=ModemManager-$(PKG_VERSION).tar.xz
 PKG_SOURCE_URL:=https://www.freedesktop.org/software/ModemManager
@@ -123,6 +123,9 @@ define Package/modemmanager/install
 	$(INSTALL_DIR) $(1)/etc/init.d
 	$(INSTALL_BIN) ./files/modemmanager.init $(1)/etc/init.d/modemmanager
 
+	$(INSTALL_DIR) $(1)/etc/hotplug.d/usb
+	$(INSTALL_DATA) ./files/25-modemmanager-usb $(1)/etc/hotplug.d/usb
+
 	$(INSTALL_DIR) $(1)/etc/hotplug.d/net
 	$(INSTALL_DATA) ./files/25-modemmanager-net $(1)/etc/hotplug.d/net
 
diff --git a/net/modemmanager/files/25-modemmanager-usb b/net/modemmanager/files/25-modemmanager-usb
new file mode 100644
index 000000000..8ca8ba10f
--- /dev/null
+++ b/net/modemmanager/files/25-modemmanager-usb
@@ -0,0 +1,13 @@
+#!/bin/sh
+# Copyright (C) 2019 Aleksander Morgado <aleksander@aleksander.es>
+
+# We need to process only full USB device removal events, we don't
+# want to process specific interface removal events.
+[ "$ACTION" = remove ] || exit
+[ -z "${INTERFACE}" ] || exit
+
+# Load common utilities
+. /etc/modemmanager/modemmanager.common
+
+mm_clear_modem_wait_status "/sys${DEVPATH}"
+mm_cleanup_interface_by_sysfspath "/sys${DEVPATH}"
diff --git a/net/modemmanager/files/modemmanager.common b/net/modemmanager/files/modemmanager.common
index 2f882e496..532d90ac0 100644
--- a/net/modemmanager/files/modemmanager.common
+++ b/net/modemmanager/files/modemmanager.common
@@ -26,6 +26,9 @@ mm_log() {
 ################################################################################
 # Receives as input argument the full sysfs path of the device
 # Returns the physical device sysfs path
+#
+# NOTE: this method only works when the device exists, i.e. it cannot be used
+# on removal hotplug events
 
 mm_find_physdev_sysfs_path() {
 	local tmp_path="$1"
@@ -96,14 +99,26 @@ mm_get_modem_wait_status() {
 	awk -v sysfspath="${sysfspath}" '!/^#/ && $0 ~ sysfspath { print $2 }' "${MODEMMANAGER_SYSFS_CACHE}"
 }
 
+# Clear the modem wait status from the cache, if any
+mm_clear_modem_wait_status() {
+	local sysfspath="$1"
+
+	local escaped_sysfspath
+
+	[ -f "${MODEMMANAGER_SYSFS_CACHE}" ] && {
+		# escape '/', '\' and '&' for sed...
+		escaped_sysfspath=$(echo "$sysfspath" | sed -e 's/[\/&]/\\&/g')
+		sed -i "/${escaped_sysfspath}/d" "${MODEMMANAGER_SYSFS_CACHE}"
+	}
+}
+
 # Sets the modem wait status in the cache
 mm_set_modem_wait_status() {
 	local sysfspath="$1"
 	local status="$2"
 
 	# Remove sysfs line before adding the new one with the new state
-	[ -f "${MODEMMANAGER_SYSFS_CACHE}" ] &&
-		sed -i "/${sysfspath}/d" "${MODEMMANAGER_SYSFS_CACHE}"
+	mm_clear_modem_wait_status "${sysfspath}"
 
 	# Add the new status
 	echo "${sysfspath} ${status}" >> "${MODEMMANAGER_SYSFS_CACHE}"
@@ -171,8 +186,7 @@ mm_wait_for_modem() {
 }
 
 mm_report_modem_wait() {
-	local action=$1
-	local sysfspath=$2
+	local sysfspath=$1
 
 	local parent_sysfspath status
 
@@ -183,53 +197,31 @@ mm_report_modem_wait() {
 	}
 
 	status=$(mm_get_modem_wait_status "${parent_sysfspath}")
-
-	[ "$action" = "add" ] && {
-		case "${status}" in
-			"")
-				local cfg
-
-				cfg=$(mm_get_modem_config "${parent_sysfspath}")
-				if [ -n "${cfg}" ]; then
-					mm_log "interface '${cfg}' is set to configure device '${parent_sysfspath}'"
-					mm_log "now waiting for modem at sysfs path ${parent_sysfspath}"
-					mm_set_modem_wait_status "${parent_sysfspath}" "processed"
-					# Launch subshell for the explicit wait
-					( mm_wait_for_modem "${cfg}" "${parent_sysfspath}" ) > /dev/null 2>&1 &
-				else
-					mm_log "no need to wait for modem at sysfs path ${parent_sysfspath}"
-					mm_set_modem_wait_status "${parent_sysfspath}" "ignored"
-				fi
-				;;
-			"processed")
-				mm_log "already waiting for modem at sysfs path ${parent_sysfspath}"
-				;;
-			"ignored")
-				;;
-			*)
-				mm_log "error: unknown status read for device at sysfs path ${parent_sysfspath}"
-				;;
-		esac
-		return
-	}
-
-	[ "$action" = "remove" ] && {
-		local cfg
-
-		[ -n "$status" ] && {
+	case "${status}" in
+		"")
 			local cfg
 
-			mm_log "cleanup wait for modem at sysfs path ${parent_sysfspath}"
-			mm_set_modem_wait_status "${parent_sysfspath}" ""
-
 			cfg=$(mm_get_modem_config "${parent_sysfspath}")
-			[ -n "${cfg}" ] && {
-				mm_log "setting interface '$cfg' as unavailable"
-				proto_set_available "${cfg}" 0
-			}
-		}
-		return
-	}
+			if [ -n "${cfg}" ]; then
+				mm_log "interface '${cfg}' is set to configure device '${parent_sysfspath}'"
+				mm_log "now waiting for modem at sysfs path ${parent_sysfspath}"
+				mm_set_modem_wait_status "${parent_sysfspath}" "processed"
+				# Launch subshell for the explicit wait
+				( mm_wait_for_modem "${cfg}" "${parent_sysfspath}" ) > /dev/null 2>&1 &
+			else
+				mm_log "no need to wait for modem at sysfs path ${parent_sysfspath}"
+				mm_set_modem_wait_status "${parent_sysfspath}" "ignored"
+			fi
+			;;
+		"processed")
+			mm_log "already waiting for modem at sysfs path ${parent_sysfspath}"
+			;;
+		"ignored")
+			;;
+		*)
+			mm_log "error: unknown status read for device at sysfs path ${parent_sysfspath}"
+			;;
+	esac
 }
 
 ################################################################################
@@ -250,6 +242,17 @@ mm_cleanup_interfaces() {
 	config_foreach mm_cleanup_interface_cb interface
 }
 
+mm_cleanup_interface_by_sysfspath() {
+	local dev="$1"
+
+	local cfg
+	cfg=$(mm_get_modem_config "$dev")
+	[ -n "${cfg}" ] || return
+
+	mm_log "setting interface '$cfg' as unavailable"
+	proto_set_available "${cfg}" 0
+}
+
 ################################################################################
 # Event reporting
 
@@ -277,8 +280,8 @@ mm_report_event() {
 	mm_log "event reported: action=${action}, name=${name}, subsystem=${subsystem}"
 	mmcli --report-kernel-event="action=${action},name=${name},subsystem=${subsystem}" 1>/dev/null 2>&1 &
 
-	# Wait for modem if a sysfspath is given
-	[ -n "${sysfspath}" ] && mm_report_modem_wait "${action}" "${sysfspath}"
+	# Wait for added modem if a sysfspath is given
+	[ -n "${sysfspath}" ] && [ "$action" = "add" ] && mm_report_modem_wait "${sysfspath}"
 }
 
 mm_report_event_from_cache_line() {

From ecad39fd6079f8b15defa1e0077d166e9507530a Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Wed, 20 Nov 2019 12:57:04 +0100
Subject: [PATCH 4/5] modemmanager: don't flag the 'device' option as 'device'
 type

Unlike other modem protocol handlers like the ones implemented by uqmi
or umbim, in the modemmanager protocol handler the 'device' option
does not specify a device node in /dev. Therefore, we shouldn't flag
the option as 'device' type (dt_type_device).

Signed-off-by: Aleksander Morgado <aleksander@aleksander.es>
---
 net/modemmanager/Makefile                 | 2 +-
 net/modemmanager/files/modemmanager.proto | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index 0c73a8880..eb8f051fe 100644
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=modemmanager
 PKG_VERSION:=1.12.0
-PKG_RELEASE:=6
+PKG_RELEASE:=7
 
 PKG_SOURCE:=ModemManager-$(PKG_VERSION).tar.xz
 PKG_SOURCE_URL:=https://www.freedesktop.org/software/ModemManager
diff --git a/net/modemmanager/files/modemmanager.proto b/net/modemmanager/files/modemmanager.proto
index b7d99f41d..536073dce 100755
--- a/net/modemmanager/files/modemmanager.proto
+++ b/net/modemmanager/files/modemmanager.proto
@@ -306,7 +306,7 @@ modemmanager_disconnected_method_common() {
 proto_modemmanager_init_config() {
 	available=1
 	no_device=1
-	proto_config_add_string	 "device:device"
+	proto_config_add_string	 device
 	proto_config_add_string	 apn
 	proto_config_add_string	 username
 	proto_config_add_string	 password

From 5f11888b124f7599fc93af13c5d2c63d08d4efe4 Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Wed, 27 Nov 2019 09:24:07 +0100
Subject: [PATCH 5/5] modemmanager: install common utils in
 /usr/share/ModemManager

The modemmanager.common file includes several utility functions that
are used in several places like the protocol handler and in hotplug
scripts. These utilities should not be installed in /etc as they're
not configuration.

Signed-off-by: Aleksander Morgado <aleksander@aleksander.es>
---
 net/modemmanager/Makefile                  | 6 ++----
 net/modemmanager/files/25-modemmanager-net | 2 +-
 net/modemmanager/files/25-modemmanager-tty | 2 +-
 net/modemmanager/files/25-modemmanager-usb | 2 +-
 net/modemmanager/files/modemmanager.init   | 4 ++--
 5 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index eb8f051fe..e616bc070 100644
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=modemmanager
 PKG_VERSION:=1.12.0
-PKG_RELEASE:=7
+PKG_RELEASE:=8
 
 PKG_SOURCE:=ModemManager-$(PKG_VERSION).tar.xz
 PKG_SOURCE_URL:=https://www.freedesktop.org/software/ModemManager
@@ -119,6 +119,7 @@ define Package/modemmanager/install
 
 	$(INSTALL_DIR) $(1)/usr/share/ModemManager
 	$(INSTALL_DATA) $(PKG_INSTALL_DIR)/usr/share/ModemManager/*.conf $(1)/usr/share/ModemManager
+	$(INSTALL_DATA) ./files/modemmanager.common $(1)/usr/share/ModemManager
 
 	$(INSTALL_DIR) $(1)/etc/init.d
 	$(INSTALL_BIN) ./files/modemmanager.init $(1)/etc/init.d/modemmanager
@@ -132,9 +133,6 @@ define Package/modemmanager/install
 	$(INSTALL_DIR) $(1)/etc/hotplug.d/tty
 	$(INSTALL_DATA) ./files/25-modemmanager-tty $(1)/etc/hotplug.d/tty
 
-	$(INSTALL_DIR) $(1)/etc/modemmanager
-	$(INSTALL_DATA) ./files/modemmanager.common $(1)/etc/modemmanager/modemmanager.common
-
 	$(INSTALL_DIR) $(1)/lib/netifd/proto
 	$(INSTALL_BIN) ./files/modemmanager.proto $(1)/lib/netifd/proto/modemmanager.sh
 endef
diff --git a/net/modemmanager/files/25-modemmanager-net b/net/modemmanager/files/25-modemmanager-net
index df15dafb2..e87231e31 100644
--- a/net/modemmanager/files/25-modemmanager-net
+++ b/net/modemmanager/files/25-modemmanager-net
@@ -3,7 +3,7 @@
 # Copyright (C) 2016 Aleksander Morgado <aleksander@aleksander.es>
 
 # Load common utilities
-. /etc/modemmanager/modemmanager.common
+. /usr/share/ModemManager/modemmanager.common
 
 # We require a interface name
 [ -n "${INTERFACE}" ] || exit
diff --git a/net/modemmanager/files/25-modemmanager-tty b/net/modemmanager/files/25-modemmanager-tty
index 60548dd66..c13148a33 100644
--- a/net/modemmanager/files/25-modemmanager-tty
+++ b/net/modemmanager/files/25-modemmanager-tty
@@ -3,7 +3,7 @@
 # Copyright (C) 2016 Aleksander Morgado <aleksander@aleksander.es>
 
 # Load hotplug common utilities
-. /etc/modemmanager/modemmanager.common
+. /usr/share/ModemManager/modemmanager.common
 
 # We require a device name
 [ -n "$DEVNAME" ] || exit
diff --git a/net/modemmanager/files/25-modemmanager-usb b/net/modemmanager/files/25-modemmanager-usb
index 8ca8ba10f..93d0bf70a 100644
--- a/net/modemmanager/files/25-modemmanager-usb
+++ b/net/modemmanager/files/25-modemmanager-usb
@@ -7,7 +7,7 @@
 [ -z "${INTERFACE}" ] || exit
 
 # Load common utilities
-. /etc/modemmanager/modemmanager.common
+. /usr/share/ModemManager/modemmanager.common
 
 mm_clear_modem_wait_status "/sys${DEVPATH}"
 mm_cleanup_interface_by_sysfspath "/sys${DEVPATH}"
diff --git a/net/modemmanager/files/modemmanager.init b/net/modemmanager/files/modemmanager.init
index 45a2ba11a..4c9548654 100755
--- a/net/modemmanager/files/modemmanager.init
+++ b/net/modemmanager/files/modemmanager.init
@@ -6,14 +6,14 @@ START=70
 
 stop_service() {
 	# Load common utils
-	. /etc/modemmanager/modemmanager.common
+	. /usr/share/ModemManager/modemmanager.common
 	# Set all configured interfaces as unavailable
 	mm_cleanup_interfaces
 }
 
 start_service() {
 	# Load common utils
-	. /etc/modemmanager/modemmanager.common
+	. /usr/share/ModemManager/modemmanager.common
 
 	# Always make sure the rundir exists
 	mkdir -m 0755 -p "${MODEMMANAGER_RUNDIR}"