fwupd/plugins/modem-manager/README.md
Richard Hughes 078beafb2d Add a new internal flag to opt-in to GUID matching
It is far too easy to forget to set FWUPD_DEVICE_FLAG_NO_GUID_MATCHING for new
plugins, and without it it all works really well *until* a user has two devices
of the same type installed at the same time and then one 'disappears' for hard
to explain reasons. Typically we only need it for replug anyway!

Explicitly opt-in to this rarely-required behaviour, with the default to just
use the physical and logical IDs. Also document the update behavior for each
plugin to explain why the flag is being used.

This allows you to have two identical Unifying plugged in without one of them
being hidden from the user, at the same time allowing a HIDRAW<->USB transition
when going to and from bootloader and runtime modes.

This removes the workaround added in 99eb3f06b6.

Fixes https://github.com/fwupd/fwupd/issues/2915
2021-02-25 15:47:25 +00:00

1.9 KiB

ModemManager

Introduction

This plugin adds support for devices managed by ModemManager.

GUID Generation

These device use the ModemManager "Firmware Device IDs" as the GUID, e.g.

  • USB\VID_413C&PID_81D7&REV_0318&CARRIER_VODAFONE
  • USB\VID_413C&PID_81D7&REV_0318
  • USB\VID_413C&PID_81D7
  • USB\VID_413C

Vendor ID Security

The vendor ID is set from the USB vendor, for example USB:0x413C

Update method: fastboot

If the device supports the 'fastboot' update method, it must also report which AT command should be used to trigger the modem reboot into fastboot mode.

Once the device is in fastboot mode, the firmware upgrade process will happen as defined e.g. in the 'flashfile.xml' file. Every file included in the CAB that is not listed in the associated 'flashfile.xml' will be totally ignored during the fastboot upgrade procedure.

Update Protocol: com.google.fastboot

For this reason the REPLUG_MATCH_GUID internal device flag is used so that the fastboot and runtime modes are treated as the same device.

Update method: qmi-pdc

If the device supports the 'qmi-pdc' update method, the contents of the CAB file should include files named as 'mcfg.*.mbn' which will be treated as MCFG configuration files to download into the device using the Persistent Device Configuration QMI service.

If a device supports both 'fastboot' and 'qmi-pdc' methods, the fastboot operation will always be run before the QMI operation, so that e.g. the full partition where the MCFG files are stored can be wiped out before installing the new ones.

Update protocol: com.qualcomm.qmi_pdc

For this reason the REPLUG_MATCH_GUID internal device flag is used so that the fastboot and runtime modes are treated as the same device.

External interface access

This plugin requires read/write access to /dev/bus/usb.