ModemManager

https://modemmanager.org/docs/
Admin
Documentation site for ModemManager and its accompanying libraries (libmbim, libqmi, and...
Tokens:27,309
Snippets:359
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install libqrtr-glib

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-meson

Install the compiled library to the prefix specified during the meson setup.

```bash
  $ sudo ninja -C build install

```

--------------------------------

### Install libqmi

Source: https://modemmanager.org/docs/libqmi/building/building-meson

Install the built libqmi library to the system using Ninja. This command installs to the prefix specified during the 'meson setup' step.

```bash
  $ sudo ninja -C build install


```

--------------------------------

### Install libqmi

Source: https://modemmanager.org/docs/libqmi/building/building-autotools

This command installs the built libqmi library to the prefix specified during the configure step. Be aware this may overwrite existing installations.

```bash
sudo make install
```

--------------------------------

### Example Build with Optional Switches

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-autotools

An example configuration for building libqrtr-glib with specific options like custom library directory, documentation generation, introspection, and debug symbols.

```bash
  $ ./configure                          \
      --prefix=/usr                      \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --enable-gtk-doc                   \
      --enable-introspection             \
      CFLAGS="-ggdb -O0"
  $ make

```

--------------------------------

### Install libmbim

Source: https://modemmanager.org/docs/libmbim/building/building-meson

Installs the compiled libmbim library to the system prefix specified during the 'meson setup' phase.

```bash
sudo ninja -C build install
```

--------------------------------

### Basic Build and Installation from Source Tarball

Source: https://modemmanager.org/docs/libqmi/building/building-autotools

Use this sequence to build and install libqmi from an official release source tarball. Ensure you are in the extracted source directory before running configure.

```bash
wget https://www.freedesktop.org/software/libqmi/libqmi-1.30.0.tar.xz
tar -Jxvf libqmi-1.30.0.tar.xz
cd libqmi-1.30.0
./configure --prefix=/usr
make
```

--------------------------------

### Example Configuration with Optional Switches

Source: https://modemmanager.org/docs/libqmi/building/building-autotools

This example demonstrates configuring libqmi with various optional switches for features like MBIM, QRTR, collection subsets, documentation, and debugging. Adjust paths and flags as needed for your system.

```bash
./configure                          \
      --prefix=/usr                      \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --enable-mbim-qmux                 \
      --enable-qrtr                      \
      --enable-collection=basic          \
      --enable-gtk-doc                   \
      --enable-introspection             \
      CFLAGS="-ggdb -O0"
make
```

--------------------------------

### Install libqrtr-glib

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-autotools

Command to install the built libqrtr-glib library to the configured prefix.

```bash
  $ sudo make install

```

--------------------------------

### Install libmbim

Source: https://modemmanager.org/docs/libmbim/building/building-autotools

Command to install the built libmbim library to the configured prefix.

```bash
sudo make install

```

--------------------------------

### Basic Build and Install from Release Tarball

Source: https://modemmanager.org/docs/libmbim/building/building-autotools

Standard procedure to download, extract, configure, and build libmbim from a source tarball. Assumes default installation prefix.

```bash
wget https://www.freedesktop.org/software/libmbim/libmbim-1.26.0.tar.xz
tar -Jxvf libmbim-1.26.0.tar.xz
cd libmbim-1.26.0
./configure --prefix=/usr
make

```

--------------------------------

### Meson Setup with Optional Switches

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-meson

Configure the build with specific library directory, release build type, enabled documentation, and disabled introspection.

```bash
  $ meson setup build \
      --prefix=/usr \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --buildtype=release \
      -Dgtk_doc=true \
      -Dintrospection=false
  $ ninja -C build

```

--------------------------------

### Example gtk-doc Warnings

Source: https://modemmanager.org/docs/contribution-guidelines/merge-requests

Illustrative example of gtk-doc warnings that may occur during the build process, indicating documentation issues.

```text
  DOC   Scanning header files
  DOC   Introspecting gobjects
  DOC   Building XML
./libmbim-glib-unused.txt:1: warning: 21 unused declarations. They should be added to libmbim-glib-sections.txt in the appropriate place.
  DOC   Building HTML
  DOC   Fixing cross-references
html/libmbim-glib-QDU.html:287: warning: no link for: "MbimQduFileType" -> (<span class="type">MbimQduFileType</span>).


```

--------------------------------

### Uninstall libqmi

Source: https://modemmanager.org/docs/libqmi/building/building-meson

Uninstall the manually installed libqmi library using Ninja. This command removes the files installed by the 'ninja install' command.

```bash
  $ sudo ninja -C build uninstall


```

--------------------------------

### Run Package Manager Installed mbimcli

Source: https://modemmanager.org/docs/faq

This command executes the mbimcli tool installed by the package manager, utilizing libraries from the default system path.

```bash
$ /usr/bin/mbimcli

```

--------------------------------

### Advanced libqmi Build with Meson and Optional Switches

Source: https://modemmanager.org/docs/libqmi/building/building-meson

Configure and build libqmi with a release build type, specific library directory, and various features disabled or enabled. This example demonstrates setting up a custom build configuration.

```bash
  $ meson setup build \
      --prefix=/usr \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --buildtype=release \
      -Dcollection=basic \
      -Dmbim_qmux=false \
      -Dqrtr=false \
      -Dgtk_doc=true \
      -Dintrospection=false \
      -Dbash_completion=false
  $ ninja -C build


```

--------------------------------

### Build and Install from Git Checkout

Source: https://modemmanager.org/docs/libmbim/building/building-autotools

Steps to build libmbim from a git repository, including generating the configure script using autogen.sh.

```bash
git clone --depth 1 --branch 1.26.0 https://gitlab.freedesktop.org/mobile-broadband/libmbim.git
cd libmbim
NOCONFIGURE=1 ./autogen.sh
./configure --prefix=/usr
make

```

--------------------------------

### Build and Installation from Git Checkout

Source: https://modemmanager.org/docs/libqmi/building/building-autotools

Follow these steps to build libqmi when cloning directly from its git repository. The `autogen.sh` script is required to set up the autotools build environment.

```bash
git clone https://gitlab.freedesktop.org/mobile-broadband/libqmi.git
cd libqmi
NOCONFIGURE=1 ./autogen.sh
./configure --prefix=/usr
make
```

--------------------------------

### Re-enable and Start ModemManager and NetworkManager (systemd)

Source: https://modemmanager.org/docs/modemmanager/debugging

After gathering debug logs, re-enable and start the systemd services for NetworkManager and ModemManager.

```bash
$> sudo systemctl enable NetworkManager ModemManager
$> sudo systemctl start NetworkManager ModemManager

```

--------------------------------

### Uninstall libmbim

Source: https://modemmanager.org/docs/libmbim/building/building-autotools

Command to uninstall libmbim if it was manually installed using 'make install'.

```bash
sudo make uninstall

```

--------------------------------

### Basic Build from Release Tarball

Source: https://modemmanager.org/docs/modemmanager/building/building-autotools

Download, extract, configure, and build ModemManager from a source tarball. Sets installation prefix and system configuration directory.

```bash
wget https://www.freedesktop.org/software/ModemManager/ModemManager-1.18.0.tar.xz
tar -Jxvf ModemManager-1.18.0.tar.xz
cd ModemManager-1.18.0
./configure --prefix=/usr --sysconfdir=/etc
make
```

--------------------------------

### Uninstall libqmi

Source: https://modemmanager.org/docs/libqmi/building/building-autotools

Use this command to uninstall libqmi if it was manually installed using the build process. It's recommended to reinstall system packages afterward if manual install overwrote them.

```bash
sudo make uninstall
```

--------------------------------

### Advanced Configuration with Optional Switches

Source: https://modemmanager.org/docs/libmbim/building/building-autotools

Example of configuring libmbim with specific options for library path, documentation rebuilding, introspection support, and debug symbols.

```bash
./configure                          \
      --prefix=/usr                      \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --enable-gtk-doc                   \
      --enable-introspection             \
      CFLAGS="-ggdb -O0"
make

```

--------------------------------

### Run Custom Installed mbimcli with LD_LIBRARY_PATH

Source: https://modemmanager.org/docs/faq

This command executes a custom-installed mbimcli tool, explicitly setting LD_LIBRARY_PATH to use libraries from /usr/local/lib.

```bash
$ LD_LIBRARY_PATH=/usr/local/lib /usr/local/bin/mbimcli

```

--------------------------------

### Uninstall libqrtr-glib

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-meson

Remove the installed library from the system.

```bash
  $ sudo ninja -C build uninstall

```

--------------------------------

### Set PKG_CONFIG_PATH for Meson Build

Source: https://modemmanager.org/docs/faq

When building a project that depends on another installed in /usr/local, set PKG_CONFIG_PATH to specify the location of .pc files for the meson build system.

```bash
$ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig meson setup ...

```

--------------------------------

### Uninstall libqrtr-glib

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-autotools

Command to uninstall the manually installed libqrtr-glib library.

```bash
  $ sudo make uninstall

```

--------------------------------

### Uninstall libmbim

Source: https://modemmanager.org/docs/libmbim/building/building-meson

Uninstalls a manually installed libmbim project using Ninja.

```bash
sudo ninja -C build uninstall
```

--------------------------------

### Query Detailed USB Device Information

Source: https://modemmanager.org/docs/modemmanager/wwan-device-types

Use `lsusb -v -d <vid:pid>` to get comprehensive details about a specific USB device, including all its available configurations. Replace `<vid:pid>` with the device's vendor and product ID.

```bash
$ lsusb -v -d <vid:pid>

```

--------------------------------

### Custom ModemManager Udev Rules

Source: https://modemmanager.org/docs/modemmanager/port-and-device-detection

Example of a user-defined udev rules file to add custom tags for modem ports. Ensure rules files are prefixed with '78-mm-' or '79-mm-'.

```udev
$ cat /lib/udev/rules.d/78-mm-my-rules.rules
ACTION!="add|change|move|bind", GOTO="mm_my_rules_end"
SUBSYSTEMS=="usb", ATTRS{idVendor}=="1234", GOTO="mm_my_rules"
GOTO="mm_my_rules_end"

LABEL="mm_my_rules"
# Store interface number in an env var
SUBSYSTEMS=="usb", ATTRS{bInterfaceNumber}=="?*", \
  ENV{.MM_USBIFNUM}="$attr{bInterfaceNumber}"
# USB iface #0 will be primary AT port
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="abcd", ENV{.MM_USBIFNUM}=="00", \
  SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY மேம்பட்டது}="1"
# USB iface #1 will be PPP port
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="abcd", ENV{.MM_USBIFNUM}=="01", \
  SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PPP} மேம்பட்டது="1"
LABEL="mm_my_rules_end"

```

--------------------------------

### Basic libqmi Build with Meson

Source: https://modemmanager.org/docs/libqmi/building/building-meson

Clone the libqmi repository, set up the build environment with Meson, and compile using Ninja.

```bash
  $ git clone https://gitlab.freedesktop.org/mobile-broadband/libqmi.git
  $ cd libqmi
  $ meson setup build --prefix=/usr
  $ ninja -C build


```

--------------------------------

### Basic Build from Git Checkout

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-meson

Clone the repository, navigate into the directory, set up the build environment with a specified prefix, and compile the library.

```bash
  $ git clone --depth 1 https://gitlab.freedesktop.org/mobile-broadband/libqrtr-glib.git
  $ cd libqrtr-glib
  $ meson setup build --prefix=/usr
  $ ninja -C build

```

--------------------------------

### Basic Build from Git Checkout

Source: https://modemmanager.org/docs/modemmanager/building/building-meson

Clones the ModemManager repository, sets up the build directory with specified prefix and sysconfdir, and compiles the project using ninja.

```bash
  $ git clone https://gitlab.freedesktop.org/mobile-broadband/ModemManager.git
  $ cd ModemManager
  $ meson setup build --prefix=/usr --sysconfdir=/etc
  $ ninja -C build

```

--------------------------------

### Basic libmbim Build with Meson

Source: https://modemmanager.org/docs/libmbim/building/building-meson

Clones the libmbim repository, sets up the build directory with a specified prefix, and compiles the library using Ninja.

```bash
git clone https://gitlab.freedesktop.org/mobile-broadband/libmbim.git
cd libmbim
meson setup build --prefix=/usr
ninja -C build
```

--------------------------------

### Build from Git Checkout

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-autotools

Steps to build libqrtr-glib from a git repository, including generating the configure script using autogen.sh.

```bash
  $ git clone https://gitlab.freedesktop.org/mobile-broadband/libqrtr-glib.git
  $ cd libqrtr-glib
  $ NOCONFIGURE=1 ./autogen.sh
  $ ./configure --prefix=/usr
  $ make

```

--------------------------------

### Advanced libmbim Build with Meson and Optional Switches

Source: https://modemmanager.org/docs/libmbim/building/building-meson

Sets up a libmbim build with advanced options including a specific library directory, release build type, enabled documentation, disabled introspection, and disabled bash completion.

```bash
meson setup build \
    --prefix=/usr \
    --libdir=/usr/lib/x86_64-linux-gnu \
    --buildtype=release \
    -Dgtk_doc=true \
    -Dintrospection=false \
    -Dbash_completion=false
ninja -C build
```

--------------------------------

### Incorrect Commit Message: Missing Module Prefix

Source: https://modemmanager.org/docs/contribution-guidelines/git-commit-style

This commit message is improperly formatted because it does not start with the required 'module: ' prefix.

```gitcommit
Added dual sim support to Quectel plugin

```

--------------------------------

### Run qmi-proxy with Verbose Logging

Source: https://modemmanager.org/docs/modemmanager/debugging

Kill existing qmi-proxy processes and launch one manually with --no-exit and --verbose flags for detailed debugging output.

```bash
$> sudo killall qmi-proxy
$> sudo /usr/libexec/qmi-proxy --no-exit --verbose

```

--------------------------------

### Basic Build from Release Tarball

Source: https://modemmanager.org/docs/libqrtr-glib/building/building-autotools

Standard procedure to download, extract, configure, and build libqrtr-glib from a source tarball.

```bash
  $ wget https://www.freedesktop.org/software/libqrtr-glib/libqrtr-glib-1.0.0.tar.xz
  $ tar -Jxvf libqrtr-glib-1.0.0.tar.xz
  $ cd libqrtr-glib-1.0.0
  $ ./configure --prefix=/usr
  $ make

```

--------------------------------

### Push Branch and Get Merge Request Link

Source: https://modemmanager.org/docs/contribution-guidelines/merge-requests

Push the local branch to the origin remote and obtain the URL to create a merge request on GitLab.

```bash
  $ cd ModemManager
  $ git checkout my-branch
  $ git push origin my-branch
  Enumerating objects: 57, done.
  Counting objects: 100% (57/57), done.
  Delta compression using up to 4 threads
  Compressing objects: 100% (26/26), done.
  Writing objects: 100% (47/47), 8.76 KiB | 2.92 MiB/s, done.
  Total 47 (delta 35), reused 32 (delta 21), pack-reused 0
  remote:
  remote:
  remote: To create a merge request for my-branch, visit:
  remote:   https://gitlab.freedesktop.org/username/ModemManager/-/merge_requests/new?merge_request%5Bsource_branch%5D=my-branch
  remote:
  To gitlab.freedesktop.org:username/ModemManager.git
   * [new branch]        my-branch -> my-branch


```

--------------------------------

### Build from Git Checkout with Autogen

Source: https://modemmanager.org/docs/modemmanager/building/building-autotools

Clone the ModemManager repository, generate the configure script using autogen.sh, and then configure and build the project. This is for development or building from the latest source.

```bash
git clone https://gitlab.freedesktop.org/mobile-broadband/ModemManager.git
cd ModemManager
NOCONFIGURE=1 ./autogen.sh
./configure --prefix=/usr --sysconfdir=/etc
make
```

--------------------------------

### Advanced Build with Optional Switches

Source: https://modemmanager.org/docs/modemmanager/building/building-meson

Sets up a build with various optional switches enabled or disabled, including library directory, build type, protocol support, suspend/resume handling, documentation generation, introspection, and bash completion.

```bash
  $ meson setup build \
      --prefix=/usr \
      --sysconfdir=/etc \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --buildtype=release \
      -Dqmi=true \
      -Dmbim=true \
      -Dqrtr=true \
      -Dsystemd_suspend_resume=false \
      -Dgtk_doc=true \
      -Dintrospection=false \
      -Dbash_completion=false
  $ ninja -C build

```

--------------------------------

### ModemManager Device Detection Log

Source: https://modemmanager.org/docs/modemmanager/port-and-device-detection

This log demonstrates the device detection phase during ModemManager bootup, showing how serial ports (ttyUSB0, ttyUSB1) and network ports (wwan0, cdc-wdm2) are identified, their attributes loaded, and how they are associated with a device. It also illustrates the filtering process and the deferral of support tasks due to a minimum wait time.

```log
// ttyUSB0 is detected via udev, a set of port identification
// parameters are preloaded.
[34.337] [ttyUSB0] port contents loaded:
[34.338] [ttyUSB0]   bus: usb
[34.339] [ttyUSB0]   interface: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.2
[34.340] [ttyUSB0]   device: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1
[34.340] [ttyUSB0]   driver: qcserial
[34.341] [ttyUSB0]   vendor: 1199
[34.341] [ttyUSB0]   product: 9091
[34.342] [ttyUSB0]   revision: 0006
[34.343] [base-manager] adding port ttyUSB0 at sysfs path: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.2/ttyUSB0/tty/ttyUSB0

// The currently active filter flags the port as allowed and specifies
// why. In this case, the specific vid (1199) is allowlisted by the
// Sierra plugin.
[34.359] [filter] (tty/ttyUSB0) port allowed: device is allowlisted by plugin (vid)

// ttyUSB0 is the first port detected in the modem device.
[34.360] [base-manager] port ttyUSB0 is first in device /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1

// A new support task is created for the device, which will determine
// which plugin takes care of managing it. In this case, the task is
// not yet launched because there is a “minimum wait time” that
// ModemManager waits before starting the probing tasks (a few
// seconds).
[34.373] [plugin-manager] task 0: new support task for device: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1
[34.391] [plugin-manager] task 0: port grabbed: ttyUSB0
[34.393] [plugin-manager] task 0,ttyUSB0: new support task for port
[34.393] [plugin-manager] task 0,ttyUSB0: deferred until min wait time elapsed

// ttyUSB1 is detected via udev, a set of port identification
// parameters are preloaded.
[34.398] [ttyUSB1] port contents loaded:
[34.398] [ttyUSB1]   bus: usb
[34.398] [ttyUSB1]   interface: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.3
[34.398] [ttyUSB1]   device: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1
[34.399] [ttyUSB1]   driver: qcserial
[34.399] [ttyUSB1]   vendor: 1199
[34.399] [ttyUSB1]   product: 9091
[34.399] [ttyUSB1]   revision: 0006
[34.399] [base-manager] adding port ttyUSB1 at sysfs path: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.3/ttyUSB1/tty/ttyUSB1
[34.402] [filter] (tty/ttyUSB1) port allowed: device is allowlisted by plugin (vid)

// ttyUSB1 is added as an additional port to the already existing
// device.
[34.404] [base-manager] additional port ttyUSB1 in device /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1

// The support task is notified about the new ttyUSB1 port, but still
// deferred.
[34.405] [plugin-manager] task 0: port grabbed: ttyUSB1
[34.407] [plugin-manager] task 0,ttyUSB1: new support task for port
[34.407] [plugin-manager] task 0,ttyUSB1: deferred until min wait time elapsed

// wwan0 net port is detected via udev, a set of port identification
// parameters are preloaded.
[34.779] [wwan0] port contents loaded:
[34.779] [wwan0]   bus: usb
[34.779] [wwan0]   interface: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.0
[34.779] [wwan0]   device: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1
[34.779] [wwan0]   driver: cdc_mbim
[34.780] [wwan0]   vendor: 1199
[34.780] [wwan0]   product: 9091
[34.780] [wwan0]   revision: 0006
[34.780] [base-manager] adding port wwan0 at sysfs path: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.0/net/wwan0
[34.782] [filter] (net/wwan0) port allowed: device is allowlisted by plugin (vid)
[34.783] [base-manager] additional port wwan0 in device /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1

// The support task is notified about the new wwan0 port, but still
// deferred.
[34.784] [plugin-manager] task 0: port grabbed: wwan0
[34.784] [plugin-manager] task 0,wwan0: new support task for port
[34.785] [plugin-manager] task 0,wwan0: deferred until min wait time elapsed

// cdc-wdm2 net port is detected via udev, a set of port
// identification parameters are preloaded.
[34.817] [cdc-wdm2] port contents loaded:
[34.817] [cdc-wdm2]   bus: usb
[34.817] [cdc-wdm2]   interface: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.0
[34.817] [cdc-wdm2]   device: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1
[34.817] [cdc-wdm2]   driver: cdc_mbim
[34.817] [cdc-wdm2]   vendor: 1199
[34.818] [cdc-wdm2]   product: 9091
[34.818] [cdc-wdm2]   revision: 0006
[34.818] [base-manager] adding port cdc-wdm2 at sysfs path: /sys/devices/pci0000:00/0000:00:14.0/usb2/2-4/2-4.1/2-4.1.1/2-4.1.1:1.0/usbmisc/cdc-wdm2
[34.819] [filter] (usbmisc/cdc-wdm2) port allowed: device is allowlisted by plugin (vid)

```

--------------------------------

### Network IPv6 Router Advertisement (RA) Message

Source: https://modemmanager.org/docs/modemmanager/ip-connectivity-setup-in-lte-modems

The network replies to the RS message with an RA, providing the global IPv6 prefix for the modem to use. This example shows the prefix but lacks MTU information.

```text
IPv6 Router Advertisement (from fe80::1 to ff02::1:ff00:1, IPv6 prefix: 2001:db8:cafe:1::/64)
```

--------------------------------

### Run mbim-proxy with Verbose Logging

Source: https://modemmanager.org/docs/modemmanager/debugging

Kill existing mbim-proxy processes and launch one manually with --no-exit and --verbose flags for detailed debugging output.

```bash
$> sudo killall mbim-proxy
$> sudo /usr/libexec/mbim-proxy --no-exit --verbose

```

--------------------------------

### Example of a Properly Formatted Commit Message

Source: https://modemmanager.org/docs/contribution-guidelines/git-commit-style

This commit message follows the recommended format with a concise subject line and a detailed body explaining the changes and the reasoning behind them. It also includes output from a memory leak detection tool.

```gitcommit
base-modem: plug leaks when organizing ports

The GLists maintained in the logic need to be explicitly freed (just
the lists, not the list contents) if we exit early on error or if we
end up deciding that the specific ports are available but unsupported
by the plugin (e.g. if a plugin that doesn't support net ports finds
net ports in the modem).

  ==225333== 24 bytes in 1 blocks are definitely lost in loss record 2,024 of 5,525
  ==225333==    at 0x483E77F: malloc (vg_replace_malloc.c:307)
  ==225333==    by 0x506C539: g_malloc (in /usr/lib/libglib-2.0.so.0.6600.7)
  ==225333==    by 0x508DC8F: g_slice_alloc (in /usr/lib/libglib-2.0.so.0.6600.7)
  ==225333==    by 0x50636B4: g_list_append (in /usr/lib/libglib-2.0.so.0.6600.7)
  ==225333==    by 0x17E671: mm_base_modem_organize_ports (mm-base-modem.c:1298)
  ==225333==    by 0x1E4409: mm_plugin_create_modem (mm-plugin.c:1094)
  ==225333==    by 0x162C81: mm_device_create_modem (mm-device.c:481)
  ==225333==    by 0x15DE60: device_support_check_ready (mm-base-manager.c:218)
  ==225333==    by 0x4EA8173: ??? (in /usr/lib/libgio-2.0.so.0.6600.7)
  ==225333==    by 0x4EAC6E8: ??? (in /usr/lib/libgio-2.0.so.0.6600.7)
  ==225333==    by 0x16730F: device_context_run_ready (mm-plugin-manager.c:1533)
  ==225333==    by 0x4EA8173: ??? (in /usr/lib/libgio-2.0.so.0.6600.7)

```

--------------------------------

### Update Local Branch After Forced Push

Source: https://modemmanager.org/docs/contribution-guidelines/merge-requests

Fetch changes from the remote and reset the local branch to match the updated remote branch. This is necessary when the remote branch has been rewritten, for example, after a maintainer's rework or a GitLab rebase operation.

```bash
git fetch origin
remote: Counting objects: 11, done.
remote: Compressing objects: 100% (6/6), done.
remote: Total 6 (delta 4), reused 0 (delta 0)
Unpacking objects: 100% (6/6), 746 bytes | 746.00 KiB/s, done.
From gitlab.freedesktop.org:username/ModemManager.git
 + b0b78e8...693b464 my-branch -> origin/my-branch  (forced update)

git checkout my-branch

git reset --hard origin/my-branch
```

--------------------------------

### Run mbimcli with Default PATH

Source: https://modemmanager.org/docs/faq

This command attempts to run mbimcli, which may lead to unexpected behavior on systems like Debian/Ubuntu if /usr/local/bin is in the PATH, as it might use the wrong library path.

```bash
$ mbimcli

```

--------------------------------

### Show Udev Info for a Port

Source: https://modemmanager.org/docs/modemmanager/port-and-device-detection

Command to display udev information, including applied tags, for a specific device port.

```bash
$ sudo udevadm info -p /sys/class/tty/ttyUSB0

```

--------------------------------

### Clone ModemManager Project Repositories

Source: https://modemmanager.org/docs/contribution-guidelines/using-gitlab/basic-setup

Use these git clone commands to check out the latest development versions of the ModemManager project and its dependencies from GitLab.

```bash
$ git clone https://gitlab.freedesktop.org/mobile-broadband/libqrtr-glib
$ git clone https://gitlab.freedesktop.org/mobile-broadband/libmbim.git
$ git clone https://gitlab.freedesktop.org/mobile-broadband/libqmi.git
$ git clone https://gitlab.freedesktop.org/mobile-broadband/ModemManager.git

```

--------------------------------

### Run ModemManager with Debug Enabled (systemd)

Source: https://modemmanager.org/docs/modemmanager/debugging

Manually execute the ModemManager daemon with the --debug flag to enable verbose logging.

```bash
$> sudo /usr/sbin/ModemManager --debug

```

--------------------------------

### Query Device Information with udevadm

Source: https://modemmanager.org/docs/modemmanager/wwan-device-types

Use this command to query all information for a specific device node managed by udev. This is useful for understanding how the system recognizes a device.

```bash
$ sudo udevadm info -p /sys/class/<subsystem>/<name>

```

--------------------------------

### Indentation and Alignment with Spaces

Source: https://modemmanager.org/docs/contribution-guidelines/coding-style

The project strictly uses 4 spaces for indentation and alignment. Tabs or longer indentations are not permitted.

```c
{
    /* indented 4 spaces */

    if (something) {
        /* indented 4 more spaces */
        do_something (variable1,
                      variable2,
                      variable3,
                      variable4);
        /* aligned  --^-- here */
    }
}
```

--------------------------------

### Advanced Configuration with Optional Switches

Source: https://modemmanager.org/docs/modemmanager/building/building-autotools

Configure ModemManager with various optional switches for specific features and build optimizations. Includes library path, protocol support, documentation, introspection, and debug flags.

```bash
./configure                          \
      --prefix=/usr                      \
      --sysconfdir=/etc                  \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --with-qmi                         \
      --with-mbim                        \
      --with-suspend-resume=systemd      \
      --enable-gtk-doc                   \
      --enable-introspection             \
      CFLAGS="-ggdb -O0"
make
```

--------------------------------

### Inspect USB Device Tree

Source: https://modemmanager.org/docs/modemmanager/wwan-device-types

Use the `lsusb --tree` command to view the hierarchical structure of USB devices and their interfaces. This helps in identifying the device and its layout.

```bash
$ lsusb --tree

```

--------------------------------

### Add Upstream Remote Repository

Source: https://modemmanager.org/docs/contribution-guidelines/using-gitlab/developer-setup

Configure the 'upstream' remote for each cloned project to point to the original mobile-broadband repository. This allows you to fetch updates from the official source.

```bash
  $ cd libqrtr-glib
  $ git remote add upstream https://gitlab.freedesktop.org/mobile-broadband/libqrtr-glib

  $ cd libmbim
  $ git remote add upstream https://gitlab.freedesktop.org/mobile-broadband/libmbim.git

  $ cd libqmi
  $ git remote add upstream https://gitlab.freedesktop.org/mobile-broadband/libqmi.git

  $ cd ModemManager
  $ git remote add upstream https://gitlab.freedesktop.org/mobile-broadband/ModemManager.git

```
Tokens:
Raw