Modem Firmware Daemon

Warning: This document is old & has moved. Please update any links:

This daemon abstracts out the common portions of updating modem firmware, i.e. deciding whether there is currently newer firmware available and getting the modem ready to be flashed with new firmware.

Modem-specific program API

In order to enforce a process boundary between the open-source modemfwd and potentially non-open-source modem firmware updaters, we farm out steps that require modem-specific knowledge to different programs. modemfwd will call into these programs with different flags to request different services. These flags are declared in the system API repo.

  • --get_fw_info: return version information for the currently installed firmware (see below)
  • --prepare_to_flash: put the modem into firmware download mode
  • --flash_main_fw=<file>
  • --flash_carrier_fw=<file>
  • --flash_mode_check: see if the modem is present in firmware download mode
  • --reboot
  • --clear_attach_apn=<carrier_id>: clear the attach APN in the modem NVM if the carrier ID is matching the one provided
  • --fw_version: can be optionally passed along with --flash_main_fw or --flash_carrier_fw to signify the firmware version of the passed file

--get_fw_info should return the main firmware on the first line, the carrier UUID on the next line and the carrier version on the one after that:

$ modem_program --get_fw_info

The carrier UUID should match with one from the shill mobile operator DB.

--flash_mode_check should return the string “true” if the modem is present in flash mode, and something else otherwise (preferably “false” for readability).

All commands should return 0 on success and something non-zero on failure. modemfwd will look for these binaries in the directory passed as the --helper_directory argument on the command line.

Helper and firmawre directory structure

The protos defined in helper_manifest.proto and firmware_manifest.proto define manifests that should be provided in the helper and firmware directories so modemfwd can figure out what devices, carriers, etc. the contents can be used with.