d/changelog: release version 0.4.3-1

Our `watch` file was looking at the wrong URL, fix that.

data/eg25-manager.service.in

@@ -4,7 +4,7 @@ Before=ModemManager.service
 
 [Service]
 Type=simple
-ExecStart=@bindir@/eg25manager
+ExecStart=@bindir@/eg25-manager
 Restart=on-failure
 ProtectControlGroups=true
 ProtectHome=true

data/meson.build

@@ -8,6 +8,7 @@ conf_files = [
 'pine64,pinephone-1.0.toml',
 'pine64,pinephone-1.1.toml',
 'pine64,pinephone-1.2.toml',
+'pine64,pinephone-pro.toml',
 ]
 
 install_data(conf_files)

data/pine64,pinephone-1.0.toml

@@ -1,4 +1,5 @@
 [manager]
+monitor_udev = true
 need_libusb = true
 usb_vid = 0x2c7c
 usb_pid = 0x0125
@@ -13,11 +14,12 @@ poweron_delay = 100000
 #recovery_timeout = 9
 
 [gpio]
-dtr = 358
+chips = [ "1c20800.pinctrl", "1f02c00.pinctrl" ]
-pwrkey = 35
+dtr = { chip = 1, line = 6 }
-reset = 68
+pwrkey = { chip = 0, line = 35 }
-apready = 231
+reset = { chip = 0, line = 68 }
-disable = 232
+apready = { chip = 0, line = 231 }
+disable = { chip = 0, line = 232 }
 
 [at]
 uart = "/dev/ttyS2"

data/pine64,pinephone-1.1.toml

@@ -1,4 +1,5 @@
 [manager]
+monitor_udev = true
 need_libusb = true
 usb_vid = 0x2c7c
 usb_pid = 0x0125
@@ -13,11 +14,12 @@ poweron_delay = 100000
 #recovery_timeout = 9
 
 [gpio]
-dtr = 358
+chips = [ "1c20800.pinctrl", "1f02c00.pinctrl" ]
-pwrkey = 35
+dtr = { chip = 1, line = 6 }
-reset = 68
+pwrkey = { chip = 0, line = 35 }
-apready = 231
+reset = { chip = 0, line = 68 }
-disable = 232
+apready = { chip = 0, line = 231 }
+disable = { chip = 0, line = 232 }
 
 [at]
 uart = "/dev/ttyS2"

data/pine64,pinephone-1.2.toml

@@ -1,4 +1,7 @@
 [manager]
+monitor_udev = true
+usb_vid = 0x2c7c
+usb_pid = 0x0125
 # Delay between setting GPIO and PWRKEY sequence, set in microseconds
 poweron_delay = 100000
 
@@ -9,12 +12,13 @@ poweron_delay = 100000
 #recovery_timeout = 9
 
 [gpio]
-dtr = 34
+chips = [ "1c20800.pinctrl" ]
-pwrkey = 35
+dtr = { chip = 0, line = 34 }
-reset = 68
+pwrkey = { chip = 0, line = 35 }
-apready = 231
+reset = { chip = 0, line = 68 }
-disable = 232
+apready = { chip = 0, line = 231 }
-status = 233
+disable = { chip = 0, line = 232 }
+status = { chip = 0, line = 233 }
 
 [at]
 uart = "/dev/ttyS2"
@@ -59,9 +63,9 @@ configure = [
     { cmd = "QSCLK", value = "1" },
 # GNSS configuration:
 #   * Enable A-GPS data upload support (XTRA)
-#   * Disable On-Demand-Positioning (ODP) mode 
+#   * Disable On-Demand-Positioning (ODP) mode
 #     to avoid running the GNSS system in the background, even when not enabled.
-#   * Enable Dynamic Power Optimizations (DPO) mode to turn off GNSS RF radios 
+#   * Enable Dynamic Power Optimizations (DPO) mode to turn off GNSS RF radios
 #     when they are not in use.
 #   * Only enable GPS and GLONASS, disable other GNSS systems.
 #     A-GPS data upload doesn't work for Galileo anyway.

data/pine64,pinephone-pro.toml

@@ -0,0 +1,100 @@
+[manager]
+monitor_udev = false
+usb_vid = 0x2c7c
+usb_pid = 0x0125
+# Delay between setting GPIO and PWRKEY sequence, set in microseconds
+poweron_delay = 100000
+
+# Uncomment the following if you need to change the modem detection timeout on
+# resume and/or the time during which suspend is blocked after modem boot
+#[suspend]
+#boot_timeout = 120
+#recovery_timeout = 9
+
+[gpio]
+chips = [ "gpio0", "gpio3" ]
+dtr = { chip = 0, line = 3 }
+pwrkey = { chip = 0, line = 13 }
+reset = { chip = 1, line = 8 }
+apready = { chip = 0, line = 12 }
+disable = { chip = 0, line = 8 }
+status = { chip = 1, line = 6 }
+
+[at]
+uart = "/dev/ttyS3"
+configure = [
+# Each command has 4 possible elements:
+#   * `cmd`   : the AT command itself, which will be translated to "AT+`cmd`"
+#   * `subcmd`: the subcommand in case a single AT command can be used
+#               to change multiple parameters, such as QCFG (optional)
+#   * `value` : the commands, argument, usually used to set the value of
+#               a specific parameter (optional)
+#   * `expect`: the expected return value; the command is first executed
+#               without any value in order to query the current state. This
+#               state is then compared to the `expect` string; if they don't
+#               match, the command is then executed with value `expect` in
+#               order to set the parameter to the configured value (optional)
+# A command can have `expect` OR `value` configured, but it shouldn't have both
+# Print software version
+    { cmd = "QGMR" },
+# Configure audio
+    { cmd = "QDAI", expect = "3,0,0,4,0,1,1,1" },
+# RI signaling using physical RI pin
+    { cmd = "QCFG", subcmd = "risignaltype", expect = "\"physical\"" },
+# Enable VoLTE support
+    { cmd = "QCFG", subcmd = "ims", expect = "1" },
+# Enable APREADY for PP 1.2
+    { cmd = "QCFG", subcmd = "apready", expect = "1,0,500" },
+# URC configuration for PP 1.2 (APREADY pin connected):
+#   * RING URC: normal pulse length
+#   * Incoming SMS URC: default pulse length
+#   * Other URC: default length
+#   * Report URCs on all ports (serial and USB) for FOSS firmware
+#   * Reporting of URCs without any delay
+#   * Configure URC pin to UART Ring Indicator
+    { cmd = "QCFG", subcmd = "urc/ri/ring", expect = "\"pulse\",120,1000,5000,\"off\",1" },
+    { cmd = "QCFG", subcmd = "urc/ri/smsincoming", expect = "\"pulse\",120,1" },
+    { cmd = "QCFG", subcmd = "urc/ri/other", expect = "\"off\",1,1" },
+    { cmd = "QCFG", subcmd = "urc/delay", expect = "0" },
+    { cmd = "QCFG", subcmd = "urc/cache", expect = "0" },
+    { cmd = "QCFG", subcmd = "urc/ri/pin", expect = "uart_ri" },
+    { cmd = "QURCCFG", subcmd = "urcport", expect = "\"all\"" },
+# Allow sleeping for power saving
+    { cmd = "QSCLK", value = "1" },
+# GNSS configuration:
+#   * Enable A-GPS data upload support (XTRA)
+#   * Disable On-Demand-Positioning (ODP) mode
+#     to avoid running the GNSS system in the background, even when not enabled.
+#   * Enable Dynamic Power Optimizations (DPO) mode to turn off GNSS RF radios
+#     when they are not in use.
+#   * Only enable GPS and GLONASS, disable other GNSS systems.
+#     A-GPS data upload doesn't work for Galileo anyway.
+#   * Avoid turning on GNSS support automatically when the modem boots.
+    { cmd = "QGPSXTRA", expect = "1" },
+    { cmd = "QGPSCFG", subcmd = "gnssconfig", expect = "4" },
+    { cmd = "QGPSCFG", subcmd = "odpcontrol", expect = "0" },
+    { cmd = "QGPSCFG", subcmd = "dpoenable", expect = "1" },
+    { cmd = "QGPSCFG", subcmd = "gpsnmeatype", expect = "31" },
+    { cmd = "QGPSCFG", subcmd = "glonassnmeatype", expect = "7" },
+    { cmd = "QGPSCFG", subcmd = "galileonmeatype", expect = "0" },
+    { cmd = "QGPSCFG", subcmd = "beidounmeatype", expect = "0" },
+    { cmd = "QGPSCFG", subcmd = "autogps", expect = "0" },
+# Disable fast poweroff for stability
+    { cmd = "QCFG", subcmd = "fast/poweroff", expect = "0" },
+# Configure sleep and wake up pin levels to active low
+    { cmd = "QCFG", subcmd = "sleepind/level", expect = "0" },
+    { cmd = "QCFG", subcmd = "wakeupin/level", expect = "0,0" },
+# Do not enter RAMDUMP mode, auto-reset instead
+    { cmd = "QCFG", subcmd = "ApRstLevel", expect = "1" },
+    { cmd = "QCFG", subcmd = "ModemRstLevel", expect = "1" },
+]
+suspend = [
+]
+resume = [
+]
+reset = [ { cmd = "CFUN", value = "1,1" } ]
+
+[gnss]
+enabled = true
+url = "https://xtrapath4.izatcloud.net"
+file = "xtra2.bin"

debian/changelog

@@ -0,0 +1,122 @@
+eg25-manager (0.4.3-1) unstable; urgency=medium
+
+  * New upstream version 0.4.3
+  * d/control: build-depend on `scdoc`
+    This is required for building the manpages. Also bump Standards-Version,
+    no other changes needed.
+  * d/watch: fix watch file
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Sat, 19 Feb 2022 15:20:14 +0100
+
+eg25-manager (0.4.2-1) unstable; urgency=medium
+
+  * d/gbp.conf: update for current Mobian workflow
+  * New upstream version 0.4.2
+
+ -- Arnaud Ferraris <arnaud.ferraris@collabora.com>  Wed, 08 Dec 2021 18:24:38 +0100
+
+eg25-manager (0.4.1-1) unstable; urgency=medium
+
+  * New upstream version 0.4.1
+  * debian: drop distro-specific systemd service.
+  * d/copyright: add missing entries
+
+ -- Arnaud Ferraris <arnaud.ferraris@collabora.com>  Fri, 08 Oct 2021 11:02:27 +0200
+
+eg25-manager (0.4.0-1) unstable; urgency=medium
+
+  [ undef ]
+  * d/service: Use systemd to sandbox eg25-manager.
+  * d/salsa-ci: Add Mobian's CI
+
+  [ Arnaud Ferraris ]
+  * New upstream version 0.4.0
+  * d/eg25-manager.service: be less restrictive.
+  * d/control: add libcurl as build dependency
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Wed, 01 Sep 2021 00:44:04 +0200
+
+eg25-manager (0.3.0-1) unstable; urgency=medium
+
+  * New upstream version 0.3.0
+
+ -- Arnaud Ferraris <arnaud.ferraris@collabora.com>  Fri, 28 May 2021 13:58:33 +0200
+
+eg25-manager (0.2.1-1) unstable; urgency=medium
+
+  * New upstream version 0.2.1
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Sun, 21 Feb 2021 16:41:31 +0100
+
+eg25-manager (0.2.0-1) unstable; urgency=medium
+
+  * New upstream version 0.2.0
+  * d/gbp.conf: enable multimaint-merge
+  * d/eg25-manager.service: remove deprecated -g option
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Sat, 20 Feb 2021 22:26:19 +0100
+
+eg25-manager (0.1.2-1) unstable; urgency=medium
+
+  * New upstream release 0.1.2
+  * d/eg25-manager.service: enable GNSS management
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Thu, 14 Jan 2021 00:09:23 +0100
+
+eg25-manager (0.1.1-1) unstable; urgency=medium
+
+  * d/control: build-depend on gudev
+  * New upstream release 0.1.1
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Fri, 18 Dec 2020 01:42:06 +0100
+
+eg25-manager (0.1.0-1) unstable; urgency=medium
+
+  * New upstream release 0.1.0
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Mon, 14 Dec 2020 16:45:20 +0100
+
+eg25-manager (0.0.6-1) unstable; urgency=medium
+
+  * New upstream release 0.0.6
+  * d/patches: drop upstreamed patches
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Fri, 11 Dec 2020 15:11:26 +0100
+
+eg25-manager (0.0.5-2) unstable; urgency=medium
+
+  * d/patches: fix crash on modem recovery
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Fri, 11 Dec 2020 14:33:14 +0100
+
+eg25-manager (0.0.5-1) unstable; urgency=medium
+
+  * New upstream release 0.0.5
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Fri, 11 Dec 2020 13:38:41 +0100
+
+eg25-manager (0.0.4-1) unstable; urgency=medium
+
+  * d/control: build only on arm64.
+  * d/service: restart daemon on failure
+  * d/control: build-depend on libusb-1.0
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Fri, 11 Dec 2020 12:51:41 +0100
+
+eg25-manager (0.0.3-1) unstable; urgency=medium
+
+  * New upstream release 0.0.3
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Thu, 10 Dec 2020 21:34:26 +0100
+
+eg25-manager (0.0.2-1) unstable; urgency=medium
+
+  * New upstream release 0.0.2
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Thu, 10 Dec 2020 19:50:50 +0100
+
+eg25-manager (0.0.1-1) unstable; urgency=medium
+
+  * Initial Debian packaging
+
+ -- Arnaud Ferraris <arnaud.ferraris@gmail.com>  Thu, 10 Dec 2020 15:19:15 +0100

debian/control

@@ -0,0 +1,29 @@
+Source: eg25-manager
+Section: libs
+Priority: optional
+Maintainer: Arnaud Ferraris <arnaud.ferraris@gmail.com>
+Standards-Version: 4.6.0
+Rules-Requires-Root: no
+Build-Depends: debhelper-compat (= 13),
+               libcurl-dev,
+               libglib2.0-dev,
+               libgpiod-dev,
+               libgudev-1.0-dev,
+               libmm-glib-dev,
+               libusb-1.0-0-dev,
+               meson,
+               scdoc <!nodoc>,
+Homepage: https://gitlab.com/mobian1/devices/eg25-manager
+Vcs-Git: https://gitlab.com/mobian1/devices/eg25-manager.git
+Vcs-Browser: https://gitlab.com/mobian1/devices/eg25-manager
+
+Package: eg25-manager
+Architecture: arm64
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         modemmanager,
+Conflicts: pinephone-modem-scripts,
+Replaces: pinephone-modem-scripts,
+Description: Manager daemon for the Quectel EG25 mobile broadband modem
+ A set of scripts for the PinePhone modem, allowing to power on/off the modem,
+ and configure its audio interface to work properly with the A64 audio codec.

debian/copyright

@@ -0,0 +1,67 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: eg25-manager
+Upstream-Contact: Arnaud Ferraris <arnaud.ferraris@gmail.com>
+Source: https://gitlab.com/mobian1/devices/eg25-manager
+
+Files: *
+Copyright: 2020 Arnaud Ferraris <arnaud.ferraris@gmail.com>
+License: GPL-3.0-or-later
+
+Files: src/gnss.*
+Copyright: 2021 Dylan Van Assche <me@dylanvanassche.be>
+License: GPL-3.0-or-later
+
+Files: src/mm-iface.c
+Copyright: 2019 Purism SPC
+           2020 Arnaud Ferraris <arnaud.ferraris@gmail.com>
+License: GPL-3.0-or-later
+
+Files: src/ofono-iface.c
+Copyright: 2020 Oliver Smith <ollieparanoid@postmarketos.org>
+           2021 Bhushan Shah <bshah@kde.org>
+License: GPL-3.0-or-later
+
+Files: src/suspend.c
+Copyright: 2012 Red Hat, Inc
+           2020 Arnaud Ferraris <arnaud.ferraris@gmail.com>
+License: GPL-3.0-or-later
+
+Files: src/toml.*
+Copyright: 2017-2019 CK Tan
+License: MIT
+
+License: GPL-3.0-or-later
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+ .
+ 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 <https://www.gnu.org/licenses/>.
+ .
+ On Debian systems, the full text of the GNU General Public License
+ version 3 can be found in the file `/usr/share/common-licenses/GPL-3'.
+
+License: MIT
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+ .
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+ .
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.

debian/gbp.conf

@@ -0,0 +1,10 @@
+[DEFAULT]
+debian-branch = mobian
+debian-tag = mobian/%(version)s
+upstream-branch = upstream/latest
+upstream-tag = %(version)s
+pristine-tar = True
+multimaint-merge = True
+
+[tag]
+sign-tags = True

debian/rules

@@ -0,0 +1,6 @@
+#!/usr/bin/make -f
+
+export DEB_BUILD_MAINT_OPTIONS = hardening=+all
+
+%:
+	dh $@

debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

debian/watch

@@ -0,0 +1,3 @@
+version=4
+https://gitlab.com/mobian1/devices/@PACKAGE@/-/tags?sort=updated_desc \
+    .*/archive/\d\S+/@PACKAGE@@ANY_VERSION@@ARCHIVE_EXT@

doc/eg25-manager.5.scd

@@ -0,0 +1,106 @@
+eg25-manager(5)
+
+# NAME
+eg25-manager configuration file format
+
+# SYNOPSIS
+eg25-manager uses toml formatted files for configuration.
+
+Configurations are loaded from:
+	- *@eg25_confdir@/<compatible>.toml*: User-provided overrides (optional)
+	- *@eg25_datadir@/<compatible>.toml*: Default configuration (required)
+
+# SECTION: manager
+General settings for eg25-manager.
+
+*poweron_delay* int (microseconds)
+	Delay between de-asserting RESET and starting the PWRKEY sequence.
+
+# SECTION: suspend
+Settings for how to handle suspend on the system where eg25-manager is running.
+
+*boot_timeout* int (seconds)
+	Prevent the system from suspending for boot_timeout seconds to allow the
+	modem to fully boot.
+
+	Default: 120 if unset or zero.
+
+*recovery_timeout* int (seconds)
+	Amount of time to wait for the modem to reappear after suspend. If the
+	timeout is reached the modem's USB connection will be reset.
+
+	Default: 9 if unset or zero.
+
+# SECTION: at
+AT commands to send when different events happen, and where to send them to.
+
+Each command has 4 possible elements:
+	- *cmd*: the AT command itself, which will be translated to "AT+`cmd`"
+	- *subcmd*: the subcommand in case a single AT command can be used to
+	  change multiple parameters, such as QCFG
+	- *value*: the command's argument(s), usually used to set the value of a
+	  specific parameter
+	- *expect*: the expected return value; the command is first executed
+	  without any value in order to query the current state. This state is
+	  then compared to the *expect* string; if they don't match, the command
+	  is then executed with value *expect* in order to set the parameter to
+	  the expected value
+A command can have *expect* OR *value* configured, but it shouldn't have both
+
+*NOTE:* If a command sequence is configured in an override file, the default
+commands won't be loaded from the system configuration. The default commands
+should be copied into the override file when changing them.
+
+*uart* string
+	The serial port to use for sending AT commands to the modem.
+
+*configure* List of commands
+	AT commands to send to the modem when it is first started.
+
+*suspend* List of commands
+	AT commands to send to the modem before the system suspends.
+
+*resume* List of commands
+	AT commands to send to the modem after the system resumes from suspend.
+
+*reset* List of commands
+	AT commands to send to the modem if resetting the usb port fails.
+
+# SECTION: gnss
+Settings for uploading AGPS assistance data to the modem.
+
+*enabled* boolean
+	Enable or disable uploading AGPS data to the modem
+
+*url* string
+	The directory on the server that contains the assistance files
+
+	Example: https://xtrapath4.izatcloud.net
+
+*file* string
+	The name of the assistance file on the server.
+
+	Example: xtra2.bin
+
+# SECTION: gpio
+The *gpio* section defines the GPIO pins to use for different modem functions.
+These settings should only be changed when porting eg25-manager to a new device;
+for this reason they aren't documented here.
+
+# EXAMPLES
+Print the firmware version every time the phone wakes from suspend:
+```
+[at]
+resume = [
+    { cmd = "QGMR" },
+]
+```
+
+Disable uploading AGPS data to the modem:
+```
+[gnss]
+enabled = false
+```
+
+# SEE AlSO
+*eg25-manager*(8)

doc/eg25-manager.8.scd

@@ -0,0 +1,37 @@
+eg25-manager(8)
+
+# NAME
+eg25-manager - a daemon for managing the Quectel EG25 modem found on the
+Pine64 PinePhone.
+
+# SYNOPSIS
+*eg25-manager* [-v] [-c config_file]
+
+# OPTIONS
+*-v*
+	Show the version number and quit.
+*-c*
+	User configuration file, defaults to the device configuration file in
+	/etc/eg25-manager.
+
+# FILES
+Configurations are loaded from:
+	- *@eg25_confdir@/<compatible>.toml*: User-provided overrides (optional)
+	- *@eg25_datadir@/<compatible>.toml*: Default configuration (required)
+
+eg25-manager will search these folders for files named after the value of the
+compatible device-tree property (with the .toml file extension) and use the
+first matching file in each directory. If no matching default configuration is
+found, eg25-manager will exit with an error message.
+
+Values from the user-provided overrides will take priority over values stored in
+the default configuration. Only changed values must be stored as user overrides,
+so eg25-manager can fall back to the default configuration as often as possible.
+
+The file names eg25-manager will check can be listed using:
+```
+xargs -0 printf '%s.toml\\n' < /proc/device-tree/compatible
+```
+
+# SEE ALSO
+*eg25-manager*(5) *ModemManager*(8) *ofono*(8)

doc/meson.build

@@ -0,0 +1,33 @@
+#
+# Copyright (C) 2020 Arnaud Ferraris <arnaud.ferraris@gmail.com>
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+scdoc = dependency('scdoc', native: true, required: false)
+if scdoc.found()
+  scdoc_prog = find_program(scdoc.get_variable('scdoc'), native: true)
+
+  foreach section: [5, 8]
+    name = 'eg25-manager'
+    out = '@0@.@1@'.format(name, section)
+
+    preprocessed = configure_file(
+      input: '@0@.scd'.format(out),
+      output: '@BASENAME@.preprocessed',
+      configuration: {
+        'eg25_confdir': eg25_confdir,
+        'eg25_datadir': eg25_datadir,
+        }
+      )
+
+    custom_target(
+      out,
+      output: out,
+      input: preprocessed,
+      command: ['sh', '-c', '@0@ < @INPUT@'.format(scdoc_prog.full_path())],
+      capture: true,
+      install: true,
+      install_dir: join_paths(get_option('mandir'), 'man@0@'.format(section)))
+  endforeach
+endif

meson.build

@@ -8,9 +8,9 @@
 project (
   'eg25-manager',
   'c',
-  version : '0.4.1',
+  version : '0.4.3',
   license : 'GPLv3+',
-  meson_version : '>= 0.50.0',
+  meson_version : '>= 0.58.0',
   default_options :
     [
       'warning_level=1',
@@ -66,5 +66,6 @@ mgr_deps = [
 ]
 
 subdir('data')
+subdir('doc')
 subdir('src')
 subdir('udev')

src/at.c

@@ -245,7 +245,14 @@ static gboolean modem_response(gint fd,
      */
     do {
         ret = read(fd, tmp, sizeof(tmp));
+
         if (ret > 0) {
+            /* If we're going to overflow truncate the data we read to fit */
+            if (pos + ret >= sizeof(response)) {
+                g_critical("AT response buffer full, truncating");
+                ret = sizeof(response) - (pos + 1);
+            }
+
             memcpy(&response[pos], tmp, ret);
             pos += ret;
             usleep(10000);

src/config.c

@@ -81,3 +81,17 @@ gboolean config_get_array(toml_table_t **config, const gchar *key, toml_array_t
 
     return !!array;
 }
+
+gboolean config_get_table(toml_table_t **config, const gchar *key, toml_table_t **result)
+{
+    toml_table_t *table = NULL;
+
+    if (config[EG25_CONFIG_USER])
+        table = toml_table_in(config[EG25_CONFIG_USER], key);
+    if (!table)
+        table = toml_table_in(config[EG25_CONFIG_SYS], key);
+    if (table && result)
+        *result = table;
+
+    return !!table;
+}

src/config.h

@@ -24,3 +24,4 @@ gboolean config_get_int(toml_table_t **config, const gchar *key, gint *result);
 gboolean config_get_uint(toml_table_t **config, const gchar *key, guint *result);
 gboolean config_get_string(toml_table_t **config, const gchar *key, gchar **result);
 gboolean config_get_array(toml_table_t **config, const gchar *key, toml_array_t **result);
+gboolean config_get_table(toml_table_t **config, const gchar *key, toml_table_t **result);

src/gpio.c

@@ -9,9 +9,9 @@
 
 #include <unistd.h>
 
+/* Those defines are used for legacy config files only */
 #define GPIO_CHIP1_LABEL "1c20800.pinctrl"
 #define GPIO_CHIP2_LABEL "1f02c00.pinctrl"
-
 #define MAX_GPIOCHIP_LINES 352
 
 enum {
@@ -101,10 +101,41 @@ int gpio_sequence_sleep(struct EG25Manager *manager)
     return 0;
 }
 
+struct gpiod_line *gpio_get_output_line(struct EG25Manager *manager, int chip, int line)
+{
+    struct gpiod_line *gpio_line;
+
+    gpio_line = gpiod_chip_get_line(manager->gpiochip[chip], line);
+    if (!gpio_line)
+        return NULL;
+
+    if (gpiod_line_request_output(gpio_line, "eg25manager", 0) < 0) {
+        gpiod_line_release(gpio_line);
+        return NULL;
+    }
+
+    return gpio_line;
+}
+
+struct gpiod_line *gpio_get_input_line(struct EG25Manager *manager, int chip, int line)
+{
+    struct gpiod_line *gpio_line;
+
+    gpio_line = gpiod_chip_get_line(manager->gpiochip[chip], line);
+    if (!gpio_line)
+        return NULL;
+
+    if (gpiod_line_request_input(gpio_line, "eg25manager") < 0) {
+        gpiod_line_release(gpio_line);
+        return NULL;
+    }
+
+    return gpio_line;
+}
+
 int gpio_init(struct EG25Manager *manager, toml_table_t *config[])
 {
-    int i, ret;
+    int i;
-    guint offset, chipidx, gpio_idx;
     toml_table_t *gpio_config[EG25_CONFIG_COUNT];
 
     for (i = 0; i < EG25_CONFIG_COUNT; i++)
@@ -113,65 +144,122 @@ int gpio_init(struct EG25Manager *manager, toml_table_t *config[])
     if (!gpio_config[EG25_CONFIG_SYS])
         g_error("Default config file lacks the 'gpio' section!");
 
-    manager->gpiochip[0] = gpiod_chip_open_by_label(GPIO_CHIP1_LABEL);
+    /*
-    if (!manager->gpiochip[0]) {
+     * The system config could have the `chips` key, but the user one
-        g_critical("Unable to open GPIO chip " GPIO_CHIP1_LABEL);
+     * could still use the old format! In order to avoid problems, we
-        return 1;
+     * should use the new format only if:
-    }
+     *   - there's no user config file
+        or
+     *   - the user config file contains the `chips` key
+     * Otherwise we might start parsing the system config with the new
+     * format, but error out if user config overrides gpios using the
+     * old format
+     */
+    if (!gpio_config[EG25_CONFIG_USER] || toml_array_in(gpio_config[EG25_CONFIG_USER], "chips"))
+    {
+        int numchips;
+        toml_array_t *chipslist = NULL;
 
-    manager->gpiochip[1] = gpiod_chip_open_by_label(GPIO_CHIP2_LABEL);
+        config_get_array(gpio_config, "chips", &chipslist);
-    if (!manager->gpiochip[1]) {
+        numchips = toml_array_nelem(chipslist);
-        g_critical("Unable to open GPIO chip " GPIO_CHIP2_LABEL);
+        if (numchips > 2)
-        return 1;
+            g_error("Requesting too many GPIO chips!");
-    }
 
-    for (i = 0; i < GPIO_OUT_COUNT; i++) {
+        for (i = 0; i < numchips; i++) {
-        if (!config_get_uint(gpio_config, gpio_out_names[i], &gpio_idx))
+            toml_datum_t data = toml_string_at(chipslist, i);
-            g_error("Unable to get config for output GPIO '%s'", gpio_out_names[i]);
+            if (!data.ok)
-
+                continue;
-        if (gpio_idx < MAX_GPIOCHIP_LINES) {
+            manager->gpiochip[i] = gpiod_chip_open_by_label(data.u.s);
-            offset = gpio_idx;
+            if (!manager->gpiochip[i])
-            chipidx = 0;
+                g_error("Unable to find GPIO chip '%s'", data.u.s);
-        } else {
-            offset = gpio_idx - MAX_GPIOCHIP_LINES;
-            chipidx = 1;
         }
 
-        manager->gpio_out[i] = gpiod_chip_get_line(manager->gpiochip[chipidx], offset);
+        for (i = 0; i < GPIO_OUT_COUNT; i++) {
-        if (!manager->gpio_out[i]) {
+            toml_table_t *table;
-            g_error("Unable to get output GPIO %d", i);
+            toml_datum_t chip, line;
-            return 1;
+            if (!config_get_table(gpio_config, gpio_out_names[i], &table))
+                g_error("Unable to get config for output GPIO '%s'", gpio_out_names[i]);
+
+            chip = toml_int_in(table, "chip");
+            if (!chip.ok || chip.u.i < 0 || chip.u.i > 2)
+                g_error("Wrong chip ID for output GPIO '%s'", gpio_out_names[i]);
+
+            line = toml_int_in(table, "line");
+            if (!line.ok || line.u.i < 0 || line.u.i > gpiod_chip_num_lines(manager->gpiochip[chip.u.i]))
+                g_error("Wrong line ID for output GPIO '%s'", gpio_out_names[i]);
+
+            manager->gpio_out[i] = gpio_get_output_line(manager, chip.u.i, line.u.i);
+            if (!manager->gpio_out[i])
+                g_error("Unable to get output GPIO %d", i);
         }
 
-        ret = gpiod_line_request_output(manager->gpio_out[i], "eg25manager", 0);
+        for (i = 0; i < GPIO_IN_COUNT; i++) {
-        if (ret < 0) {
+            toml_table_t *table;
-            g_error("Unable to request output GPIO %d", i);
+            toml_datum_t chip, line;
-            return 1;
+
+            if (!config_get_table(gpio_config, gpio_in_names[i], &table)) {
+                // BH edition don't have the STATUS line connected, ignore it
+                if (manager->use_libusb && g_strcmp0(gpio_in_names[i], "status") == 0)
+                    continue;
+                g_error("Unable to get config for input GPIO '%s'", gpio_in_names[i]);
+            }
+
+            chip = toml_int_in(table, "chip");
+            if (!chip.ok || chip.u.i < 0 || chip.u.i > 2)
+                g_error("Wrong chip ID for input GPIO '%s'", gpio_in_names[i]);
+
+            line = toml_int_in(table, "line");
+            if (!line.ok || line.u.i < 0 || line.u.i > gpiod_chip_num_lines(manager->gpiochip[chip.u.i]))
+                g_error("Wrong line ID for input GPIO '%s'", gpio_in_names[i]);
+
+            manager->gpio_in[i] = gpio_get_input_line(manager, chip.u.i, line.u.i);
+            if (!manager->gpio_in[i])
+                g_error("Unable to get input GPIO %d", i);
         }
-    }
+    } else {
+        guint offset, chipidx, gpio_idx;
 
-    for (i = 0; i < GPIO_IN_COUNT; i++) {
+        /* Legacy config file, only used on the OG PinePhone */
-        if (!config_get_uint(gpio_config, gpio_in_names[i], &gpio_idx))
+        manager->gpiochip[0] = gpiod_chip_open_by_label(GPIO_CHIP1_LABEL);
-            continue;
+        if (!manager->gpiochip[0])
+            g_error("Unable to open GPIO chip " GPIO_CHIP1_LABEL);
 
-        if (gpio_idx < MAX_GPIOCHIP_LINES) {
+        manager->gpiochip[1] = gpiod_chip_open_by_label(GPIO_CHIP2_LABEL);
-            offset = gpio_idx;
+        if (!manager->gpiochip[1])
-            chipidx = 0;
+            g_error("Unable to open GPIO chip " GPIO_CHIP2_LABEL);
-        } else {
+
-            offset = gpio_idx - MAX_GPIOCHIP_LINES;
+        for (i = 0; i < GPIO_OUT_COUNT; i++) {
-            chipidx = 1;
+            if (!config_get_uint(gpio_config, gpio_out_names[i], &gpio_idx))
+                g_error("Unable to get config for output GPIO '%s'", gpio_out_names[i]);
+
+            if (gpio_idx < MAX_GPIOCHIP_LINES) {
+                offset = gpio_idx;
+                chipidx = 0;
+            } else {
+                offset = gpio_idx - MAX_GPIOCHIP_LINES;
+                chipidx = 1;
+            }
+
+            manager->gpio_out[i] = gpio_get_input_line(manager, chipidx, offset);
+            if (!manager->gpio_out[i])
+                g_error("Unable to get output GPIO %d", i);
         }
 
-        manager->gpio_in[i] = gpiod_chip_get_line(manager->gpiochip[chipidx], offset);
+        for (i = 0; i < GPIO_IN_COUNT; i++) {
-        if (!manager->gpio_in[i]) {
+            if (!config_get_uint(gpio_config, gpio_in_names[i], &gpio_idx))
-            g_warning("Unable to get input GPIO %d", i);
+                continue;
-            continue;
-        }
 
-        ret = gpiod_line_request_input(manager->gpio_in[i], "eg25manager");
+            if (gpio_idx < MAX_GPIOCHIP_LINES) {
-        if (ret < 0) {
+                offset = gpio_idx;
-            g_warning("Unable to request input GPIO %d", i);
+                chipidx = 0;
-            manager->gpio_in[i] = NULL;
+            } else {
+                offset = gpio_idx - MAX_GPIOCHIP_LINES;
+                chipidx = 1;
+            }
+
+            manager->gpio_in[i] = gpio_get_input_line(manager, chipidx, offset);
+            if (!manager->gpio_in[i])
+                g_error("Unable to get input GPIO %d", i);
         }
     }
 

src/manager.c

@@ -38,6 +38,9 @@
 #define EG25_VERSION "0.0.0"
 #endif
 
+#define EG25_DEFAULT_VENDOR_ID  0x2c7c
+#define EG25_DEFAULT_PRODUCT_ID 0x0125
+
 #define POWERON_DELAY_US 100000UL
 
 static gboolean quit_app(struct EG25Manager *manager)
@@ -141,7 +144,7 @@ void modem_configure(struct EG25Manager *manager)
 static gboolean modem_reset_done(struct EG25Manager* manager)
 {
     manager->modem_state = EG25_STATE_RESUMING;
-    manager->reset_timer = 0;
+    manager->complete_reset_timer = 0;
     return FALSE;
 }
 
@@ -149,7 +152,18 @@ gboolean modem_reset(struct EG25Manager *manager)
 {
     int fd, ret, len;
 
-    if (manager->reset_timer) {
+    /* reset sequence started, cannot be canceled anymore */
+    if (manager->schedule_reset_timer) {
+        g_source_remove(manager->schedule_reset_timer);
+        manager->schedule_reset_timer = 0;
+    }
+
+    if (manager->modem_recovery_timer) {
+        g_source_remove(manager->modem_recovery_timer);
+        manager->modem_recovery_timer = 0;
+    }
+
+    if (manager->complete_reset_timer) {
         g_message("modem_reset: timer already setup, skipping...");
         return G_SOURCE_REMOVE;
     }
@@ -164,11 +178,6 @@ gboolean modem_reset(struct EG25Manager *manager)
         return G_SOURCE_REMOVE;
     }
 
-    if (manager->modem_recovery_timer) {
-        g_source_remove(manager->modem_recovery_timer);
-        manager->modem_recovery_timer = 0;
-    }
-
     if (!manager->modem_usb_id) {
         g_warning("Empty modem USB ID");
         goto error;
@@ -210,7 +219,7 @@ gboolean modem_reset(struct EG25Manager *manager)
      * 3s is long enough to make sure the modem has been bound back and
      * short enough to ensure it hasn't been acquired by ModemManager
      */
-    manager->reset_timer = g_timeout_add_seconds(3, G_SOURCE_FUNC(modem_reset_done), manager);
+    manager->complete_reset_timer = g_timeout_add_seconds(3, G_SOURCE_FUNC(modem_reset_done), manager);
 
     return G_SOURCE_REMOVE;
 
@@ -228,7 +237,7 @@ error:
     at_sequence_reset(manager);
 
     // Setup timer for making sure we don't queue other reset commands
-    manager->reset_timer = g_timeout_add_seconds(30, G_SOURCE_FUNC(modem_reset_done), manager);
+    manager->complete_reset_timer = g_timeout_add_seconds(30, G_SOURCE_FUNC(modem_reset_done), manager);
 
     return G_SOURCE_REMOVE;
 }
@@ -314,6 +323,7 @@ int main(int argc, char *argv[])
     struct EG25Manager manager;
     gchar *config_file = NULL;
     gboolean show_version = FALSE;
+    gboolean monitor_udev = TRUE;
     toml_table_t *toml_config[EG25_CONFIG_COUNT];
     toml_table_t *manager_config[EG25_CONFIG_COUNT];
     const GOptionEntry options[] = {
@@ -363,10 +373,13 @@ int main(int argc, char *argv[])
     if (!manager_config[EG25_CONFIG_SYS])
         g_error("Default config file lacks the 'manager' section!");
 
+    config_get_bool(manager_config, "monitor_udev", &monitor_udev);
     config_get_bool(manager_config, "need_libusb", &manager.use_libusb);
-    config_get_uint(manager_config, "usb_vid", &manager.usb_vid);
-    config_get_uint(manager_config, "usb_pid", &manager.usb_pid);
     config_get_uint(manager_config, "poweron_delay", &manager.poweron_delay);
+    if (!config_get_uint(manager_config, "usb_vid", &manager.usb_vid))
+        manager.usb_vid = EG25_DEFAULT_VENDOR_ID;
+    if (!config_get_uint(manager_config, "usb_pid", &manager.usb_pid))
+        manager.usb_pid = EG25_DEFAULT_PRODUCT_ID;
 
     at_init(&manager, toml_config);
     gpio_init(&manager, toml_config);
@@ -375,7 +388,8 @@ int main(int argc, char *argv[])
 #endif
     ofono_iface_init(&manager, toml_config);
     suspend_init(&manager, toml_config);
-    udev_init(&manager, toml_config);
+    if (monitor_udev)
+        udev_init(&manager, toml_config);
     gnss_init(&manager, toml_config);
 
     for (int i = 0; i < EG25_CONFIG_COUNT; i++) {

src/manager.h

@@ -53,6 +53,7 @@ enum EG25State {
     EG25_STATE_SUSPENDING, // System is going into suspend
     EG25_STATE_RESUMING, // System is being resumed, waiting for modem to come back
     EG25_STATE_RESETTING, // Something went wrong, we're restarting the modem
+    EG25_STATE_UPDATING, // Modem is present but being updated
     EG25_STATE_FINISHING
 };
 
@@ -70,7 +71,8 @@ enum EG25Config {
 
 struct EG25Manager {
     GMainLoop *loop;
-    guint reset_timer;
+    guint complete_reset_timer;
+    guint schedule_reset_timer;
     gboolean use_libusb;
     guint usb_vid;
     guint usb_pid;

src/meson.build

@@ -25,7 +25,7 @@ if mmglib_dep.found()
 endif
 
 executable (
-    'eg25manager',
+    'eg25-manager',
     src,
     dependencies : mgr_deps,
     link_with: gdbofono_lib,

src/suspend.c

@@ -18,10 +18,24 @@
 #define SD_PATH         "/org/freedesktop/login1"
 #define SD_INTERFACE    "org.freedesktop.login1.Manager"
 
+static void resume_ok(struct EG25Manager *manager)
+{
+    manager->modem_state = EG25_STATE_CONFIGURED;
+    modem_resume_post(manager);
+}
+
 static gboolean check_modem_resume(struct EG25Manager *manager)
 {
-    g_message("Modem wasn't probed in time, restart it!");
     manager->modem_recovery_timer = 0;
+
+#ifdef HAVE_MMGLIB
+    if (manager->mm_modem) {
+        resume_ok(manager);
+        return FALSE;
+    }
+#endif
+
+    g_message("Modem wasn't probed in time, restart it!");
     modem_reset(manager);
 
     return FALSE;
@@ -184,8 +198,7 @@ static void signal_cb(GDBusProxy *proxy,
              * If modem is managed by ofono, we also do resume sequence immediately
              * as ofono handles resuming from sleep itself.
              */
-            manager->modem_state = EG25_STATE_CONFIGURED;
+            resume_ok(manager);
-            modem_resume_post(manager);
         } else {
             manager->modem_state = EG25_STATE_RESUMING;
             manager->modem_recovery_timer = g_timeout_add_seconds(manager->modem_recovery_timeout,

src/udev.c

@@ -11,18 +11,47 @@
 static void udev_event_cb(GUdevClient *client, gchar *action, GUdevDevice *device, gpointer data)
 {
     struct EG25Manager *manager = data;
+    const gchar *prop;
+    long vid = 0, pid = 0;
+
+    /*
+     * Act only if the device is the one identified as a modem by MM/ofono
+     */
+    if (!manager->modem_usb_id ||
+        strcmp(g_udev_device_get_name(device), manager->modem_usb_id) != 0) {
+        return;
+    }
+
+    prop = g_udev_device_get_property(device, "ID_VENDOR_ID");
+    if (prop)
+        vid = strtol(prop, NULL, 16);
+
+    prop = g_udev_device_get_property(device, "ID_MODEL_ID");
+    if (prop)
+        pid = strtol(prop, NULL, 16);
+
+    if (strcmp(action, "bind") == 0 && vid != manager->usb_vid && pid != manager->usb_pid) {
+        /*
+         * Modem is probably executing a FW upgrade, make sure we don't interrupt it
+         */
+        if (manager->schedule_reset_timer != 0) {
+            g_message("Modem re-appeared with different VID/PID, cancel reset.");
+            g_source_remove(manager->schedule_reset_timer);
+            manager->schedule_reset_timer = 0;
+        }
+        manager->modem_state = EG25_STATE_UPDATING;
+    }
 
     if (strcmp(action, "unbind") != 0 ||
+        manager->modem_state == EG25_STATE_UPDATING ||
         manager->modem_state == EG25_STATE_RESETTING ||
-        !manager->modem_usb_id) {
+        manager->complete_reset_timer != 0 ||
+        manager->schedule_reset_timer != 0) {
         return;
-        }
-
-    if (strcmp(g_udev_device_get_name(device), manager->modem_usb_id) == 0 &&
-        manager->reset_timer == 0) {
-        g_message("Lost modem, resetting...");
-        g_timeout_add_seconds(2, G_SOURCE_FUNC(modem_reset), manager);
     }
+
+    g_message("Lost modem, resetting...");
+    manager->schedule_reset_timer = g_timeout_add_seconds(3, G_SOURCE_FUNC(modem_reset), manager);
 }
 
 void udev_init (struct EG25Manager *manager, toml_table_t *config[])