Selecting the Correct Firmware Package per Modem

2174120-1.0
Author: Sierra Wireless Date: May 1, 2017

APN Content Level BASIC INTERMEDIATE ADVANCED Confidentiality Public Private

EM/MC73xx WP75xx
Hardware
Product Line AirPrime Series EM/MC74xx
Compatibility
WP85xx

Document
Software Compatibility ALL Application Note Technical Note
Type

1 Version
These documents may be updated over their lifetime. To ensure you design with the correct version, please check The
Source page on www.sierrawireless.com for latest versions.

2 Introduction
This document is provided to Sierra Wireless distributors and clients to aid more rapid development of embedded applications
using the Sierra Wireless portfolio of cellular solutions. To request a new application/technical note, contact your regional
Sierra Wireless Product Marketing Manager.

3 Application/Technical Note Description

The Sierra Wireless MDM9X15 and MDM9X30 family of modems support carrier switching. This is a feature where the same
modem can be used with different carriers from different geographies by downloading and activating the correct FW package
for the carrier and modem.
This document explains how customers can match a FW package with the correct supported modem.
This document uses APIs from Sierra Wireless Linux QMI SDK.

4 Modem Family and Models

This section lists the modem family and modem models that apply to this application note.

4.1 MDM9X15 Family

This family of modems are based on the MDM9X15 chipset from Qualcomm.

4.1.1 EM/MC73xx
The EM/MC73xx modems use the firmware base C. SWI9X15C. This family of modems include the following models:
7355, 7354, 7354B, 7350, 7305, 7304, 7330

4.1.2 WP85xx and WP75xx

The WP85XX and WP75XX modems use the firmware base Y. SWI9X15Y
This family of modems include the following models: WP8548, WP7504, WP7502

4.2 MDM9X30 Family

This family of modems are based on the MDM9X30 chipset from Qualcomm.

4.2.1 EM/MC74XX
The EM/MC74xx modems use the firmware base C. SWI9X30C.
This family of modems include the following models: EM7455, MC7455, EM7430, and MC7430.

2174120 Rev 1.0 May 1, 2017 1

 Selecting the Correct Firmware Package per Modem
2174120-1.0

5 Firmware Components and Packages

5.1 Components
The components that can make up a FW package are:
Modem Firmware : .cwe
Carrier PRI : .nvu
OEM PRI (SKU specific updates): .nvu
MCU/Legato/Yocto : .cwe (for WP modems)

5.2 Packages
A firmware package is combination of one of more of the above components.

5.2.1 SPKG Package

A SPKG package is a .spk file that can include
1 carrier PRI
1 OEM PRI
1 Modem firmware
MCU/Legato/Yocto firmware
A SPKG package can be a
SKU specific configuration update OR
SKU specific carrier package OR
SKU independent carrier package

5.2.2 Carrier CWE+NVU Package

This is a valid combination of 1 Carrier FW + 1 Carrier PRI and will be specific to a carrier and is SKU independent. The Sierra
Wireless support website http://source.sierrawireless.com provides the list of approved carrier FW+ carrier PRI version
information for different modems.

Note: Customers should choose the correct combination of carrier FW file (.cwe) and carrier PRI (.nvu) based on the
Sierra provided approved list.

6 Selecting the Correct Modem for an Firmware Package

This section explains with examples how information can be obtained from a FW package using Linux QMI SDK APIs. This
information can then be used to select the modem for which the FW package is intended for.

6.1 Linux QMI SDK APIs

The following Linux QMI SDK APIs are used with this document. Please refer to the SDKs documentation for more
information. The examples shown with this document are from the Linux QMI SDK sample application
MC7xxx_Image_Management. Please refer to the sample application for more information

Table 1: Linux QMI SDK APIs

Action Description

SLQSGetImageInfo_9x15() Used to read information regarding FW packages stored

on the host.
Used to read the running FW version, Model ID and SKU
SLQSGetFirmwareInfo()
from the modem.

2174120 Rev 1.0 May 1, 2017 2

 Selecting the Correct Firmware Package per Modem
2174120-1.0

6.2 Identifying a SKU Specific Package

A SKU specific SPKG package or OEM PRI NVU file can only be used with the intended modem SKU. For example a SKU
specific package for SKU 1102036 should be used only with SKU 1102036 MC7350 modem. It should not be used with a
MC7350 modem from another SKU.

Note: The modem will reject cross SKU FW package downloads with a generic error.
The SKU ID and the Model ID returned by SLQSGetImageInfo_9x15() will identify the modem and the SKU for which the
package is intended.

6.2.1 SPKG SKU Packages

Following is an example of a SKU package for MC7350. Output below is from SDK API SLQSGetImageInfo_9x15().
Package file: 1102036_9903208_MC7350_05.05.42.00_00_xyz_005.002_000-field.spk
Model ID: MC7350
BOOT Version: 05.05.42.00
AMSS Version: 05.05.42.00
SKU ID: 1102036
Package ID: 000
Carrier: xyz
PRI version: 005.002
If the SKU ID from SLQSGetFirmwareInfo() matches the SKU ID from the FW package, then this package can be downloaded
to the modem.

6.2.2 OEM PRI

Following is an example of an EM7455 OEM PRI. Output below is from SDK API SLQSGetImageInfo_9x15().
74xx OEM PRI file: 1102526_9905080_EM7455_02.14.03.00_00_xyz_000.006_000.nvu
Model ID: EM7455
BOOT Version: 02.14.03.00
AMSS Version: 02.14.03.00
SKU ID: 1102526
Package ID: 000
Carrier: xyz
PRI version: 000.006
If the SKU ID from SLQSGetFirmwareInfo() matches the SKU ID from the OEM PRI, then this OEM PRI can be downloaded to
the modem.

6.3 SKU Independent Carrier Firmware or Package

A SKU independent carrier package can be downloaded to any modem from the same family. For example a carrier package
for modem family SWI9X30C can be downloaded to any 74xx modem.
But certain modem models support only certain carriers based on the bands supported by the modem. So the host application
has to choose the modem for which the carrier package is destined for and download the package accordingly.

6.3.1 Identifying a SKU Independent Package

The SKU ID returned by SLQSGetImageInfo_9x15()will help to identify whether the package is SKU dependent or not.
If the SKU ID of the package is set to 9999999, then the package is a SKU independent package.
73xx ATT Carrier Package:
9999999_9902196_SWI9X15C_05.05.58.00_00_ATT_005.026_000-field.spk
Model ID: SWI9X15C
BOOT Version: 05.05.58.00
AMSS Version: 05.05.58.00
SKU ID: 9999999
Package ID: 000
Carrier: ATT
PRI version: 005.026

2174120 Rev 1.0 May 1, 2017 3

 Selecting the Correct Firmware Package per Modem
2174120-1.0

6.3.2 Identifying the Modem Family Supported By the Package

The Model ID returned by SLQSGetImageInfo_9x15() will helped to identify the modem family supported by the package.

Table 2: Modem Family Identification

Model ID from Firmware Package Modem Family

SWI9X15C EM/MC73xx
SWI9X15Y WP85xx, WP75xx
SWI9X30C EM/MC74xx

6.3.3 73xx Carrier Package

Example below is for 73xx modems
9999999_9902196_SWI9X15C_05.05.58.00_00_ATT_005.026_000-field.spk
Model ID: SWI9X15C
BOOT Version: 05.05.58.00
AMSS Version: 05.05.58.00
SKU ID: 9999999
Package ID: 000
Carrier: ATT
PRI version: 005.026

6.3.4 WPx5xx Carrier Package

Example below is for WP75xx and WP85xx modems
9999999_9905133_SWI9X15Y_07.09.02.00_00_SPRINT_001.005_709-field.spk
Model ID: SWI9X15Y
BOOT Version: 07.09.02.00
AMSS Version: 07.09.02.00
SKU ID: 9999999
Package ID: 709
Carrier: SPRINT
PRI version: 001.005

6.3.5 74xx Carrier Package

Example below is for 74xx modems
SWI9X30C_02.20.03.00_ATT_002.019_000.nvu + SWI9X30C_02.20.03.00.cwe
Model ID: SWI9X30C
BOOT Version: 02.20.03.00
AMSS Version: 02.20.03.00
SKU ID: 9999999
Package ID: 000
Carrier: ATT
PRI version: 002.019

6.3.6 Identifying the Modem for Package Download

Once the family of the modems to use the package with has been identified, then the Carrier that the package supports should
be used to match the modem. The list of carriers supported by each modem is provided at http://source.sierrawireless.com.
Please refer the support section for each modem to find out the list of supported carriers.

Note: The links listed below will be updated regularly by SWI. Please ensure that your tables are up to date.

6.3.7 List of Supported Carriers for SWI9X30C (74xx) Modems

http://source.sierrawireless.com/resources/airprime/minicard/74xx/airprime-em_mc74xx-approved-fw-packages/
Below is an example carrier and modem matching table based on the above link.

2174120 Rev 1.0 May 1, 2017 4

 Selecting the Correct Firmware Package per Modem
2174120-1.0

Table 3: Example Carrier and Modem Matching Table

Carriers Supported on Modem

AT&T
Generic
Rogers
7455
Sprint
Verizon
Vodafone
DoCoMo
KDDI
Generic 7430
Softbank
Telstra

6.3.8 List of Supported Carriers for SWI9X15C (73xx) Modems

A list of supported carriers is available under the AirPrime MC73xx Series Source page, by clicking the Firmware link in the
Software download section.

6.3.9 List of Supported Carriers for SWI9X15Y (WP) Modems

A list of supported carriers is available under the AirPrime WP Series Source page, by clicking the Firmware link in the
Software download section.

6.4 Identifying the Modem to Be Upgraded

The SDK API SLQSGetFirmwareInfo() can be used to obtain information about the attached modem. Once modem information
is available, please refer to the steps above to decide whether a FW upgrade can be performed or not.

6.5 Example
This example uses the points discussed above to decide whether FW packages can be downloaded to the connected MC7354
modem.
SLQSGetFirmwareInfo:
Model Id: MC7354
Boot Version: SWI9X15C_05.05.58.01 r27044 carmd-fwbuild1 2015/03/05 00:02:40
Application Version: SWI9X15C_05.05.58.01 r27044 carmd-fwbuild1 2015/03/05 00:02:40
SKU Id: 1102016
Package Id: 1102016_9903211_SWI9X15C_05.05.16.02_00_Generic_005.005_000
Carrier: 5
PRI Version: 05.05
For this MC7354 modem, we can download FW package
9999999_9902196_SWI9X15C_05.05.58.00_00_ATT_005.026_000-field.spk.
We cannot download SKU dependent FW package 1102036_9903208_MC7350_05.05.42.00_00_xyz_005.002_000-
field.spk as the SKU is different.

6.6 Identifying Separate .cwe and .nvu Files

The 9X15 and 9X30 based Sierra modems support downloading separate .cwe and .nvu files. This section explains how to
match the FW files to a modem in these scenarios.

6.6.1 Separate Firmware (.cwe) Files

Sometimes a FW file will need to be downloaded separately. In this case, the model ID will be set to the modem family and
SKU ID will be set to internal.

2174120 Rev 1.0 May 1, 2017 5

 Selecting the Correct Firmware Package per Modem
2174120-1.0

73xx.cwe file: Testbuild_For_73xx.cwe

Model ID: SWI9X15C
BOOT Version: 00.00.00.00
AMSS Version: 00.00.00.00
SKU ID: INTERNAL

74xx .cwe file: SWI9X30C_02.20.03.00.cwe

Model ID: SWI9X30C
BOOT Version: 02.20.03.00
AMSS Version: 02.20.03.00
SKU ID: INTERNAL

6.6.2 Separate Carrier PRI (.nvu)

A carrier PRI should be treated as a complete carrier package and modem matching should be done accordingly.

6.6.3 Separate OEM PRI (.nvu)

An OEM PRI is SKU specific. Modem matching should be done similar to a SKU specific package.

2174120 Rev 1.0 May 1, 2017 6

 Selecting the Correct Firmware Package per Modem
2174120-1.0

6.7 Decision Flow

START

.cwe+.nvu FW
SPKG FW Package .nvu file .cwe file Read from modem
package

Read from FW
Read Modem family package on the host
Read SKU and model Read Modem family
and Carrier from FW
ID from package FW file
package
NO

Get supported modem model

SKU package or
using modem family and carrier
OEM PRI?
and approved carrier list for
modem (use carrier list from
source.sierrawireless.com)

YES

Read SKU and Read modem model Read modem model

Model ID from ID from connected ID from connected
connected modem modem modem

Does FW Does connected Does connected

package SKU and modem support modem fall in
Model ID match the carrier? FW family?
with info from YES
modem?

Perform FW
YES YES
download

NO

NO NO

STOP

Figure 1. Decision Flow

2174120 Rev 1.0 May 1, 2017 7

 Selecting the Correct Firmware Package per Modem
2174120-1.0

7 References
Linux QMI SDK Documentation
Linux QMI SDK - Application Developer's Guide
4118344_Image Switching M2M Developers Guide_r2
Support pages for individual modem from http://source.sierrawireless.com

8 Support
For direct clients: contact your Sierra Wireless FAE
For distributor clients: contact your distributor FAE
For distributors: contact your Sierra Wireless FAE

9 Document History

Revision Date History

1.0 April 17, 2017 Creation

10 Legal Notice
Important Notice

Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be totally lost. Although significant delays or losses of data are
rare when wireless devices such as the Sierra Wireless modem are used in a normal manner with a well-constructed network, the Sierra Wireless modem should not be used in situations where failure to transmit or receive data
could result in damage of any kind to the user or any other party, including but not limited to personal injury, death, or loss of property. Sierra Wireless accepts no responsibility for damages of any kind resulting from delays or
errors in data transmitted or received using the Sierra Wireless modem, or for failure of the Sierra Wireless modem to transmit or receive such data.

Safety and Hazards

Do not operate the Sierra Wireless modem in areas where cellular modems are not advised without proper device certifications. These areas include environments where cellular radio can interfere such as explosive
atmospheres, medical equipment, or any other equipment which may be susceptible to any form of radio interference. The Sierra Wireless modem can transmit signals that could interfere with this equipment. Do not operate the
Sierra Wireless modem in any aircraft, whether the aircraft is on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE POWERED OFF. When operating, the Sierra Wireless modem can transmit signals that
could interfere with various onboard systems.

Note: Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is open. Sierra Wireless modems may be used at this time.

The driver or operator of any vehicle should not operate the Sierra Wireless modem while in control of a vehicle. Doing so will detract from the driver or operators control and operation of that vehicle. In some states and
provinces, operating such communications devices while in control of a vehicle is an offence.

Limitations of Liability

This manual is provided as is. Sierra Wireless makes no warranties of any kind, either expressed or implied, including any implied warranties of merchantability, fitness for a particular purpose, or noninfringement. The recipient
of the manual shall endorse all risks arising from its use.

The information in this manual is subject to change without notice and does not represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY
AND ALL DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PROFITS OR REVENUE OR ANTICIPATED
PROFITS OR REVENUE ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES OR THEY ARE FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.

Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its affiliates aggregate liability arising under or in connection with the Sierra Wireless product, regardless of the number of events, occurrences, or claims
giving rise to liability, be in excess of the price paid by the purchaser for the Sierra Wireless product.

Patents

This product may contain technology developed by or for Sierra Wireless Inc.

This product includes technology licensed from QUALCOMM .

This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents licensed from InterDigital Group and MMP Portfolio Licensing.

Copyright

2017 Sierra Wireless. All rights reserved.

Trademarks

Sierra Wireless , AirPrime , AirLink , AirVantage , WISMO , ALEOS and the Sierra Wireless and Open AT logos are registered trademarks of Sierra Wireless, Inc. or one of its subsidiaries.

Watcher is a registered trademark of Netgear, Inc., used under license.

Windows and Windows Vista are registered trademarks of Microsoft Corporation.

Macintosh and Mac OS X are registered trademarks of Apple Inc., registered in the U.S. and other countries.

QUALCOMM is a registered trademark of QUALCOMM Incorporated. Used under license.

Other trademarks are the property of their respective owners.

2174120 Rev 1.0 May 1, 2017 8