Quectel Cellular Engine€¦ · FW_Upgrade_Tool_Advanced_WS1_UGD_V1.0 -12 - Figure 7: UI of Set New...

U10 Quectel Cellular Engine

Firmware Upgrade

Tool Advanced

User Guide FW_Upgrade_Tool_Advanced_UGD_V1.0

Firmware Upgrade Tool Advanced WS1 User Guide

FW_Upgrade_Tool_Advanced_WS1_UGD_V1.0 -1 -

General Notes

Quectel offers this information as a service to its customers, to support application and

engineering efforts that use the products designed by Quectel. The information provided is

based upon requirements specifically provided to Quectel by the customers. Quectel has not

undertaken any independent search for additional relevant information, including any

information that may be in the customer’s possession. Furthermore, system validation of this

product designed by Quectel within a larger electronic system remains the responsibility of

the customer or the customer’s system integrator. All specifications supplied herein are

subject to change.

Copyright

This document contains proprietary technical information which is the property of Quectel

Limited. The copying of this document, distribution to others, and communication of the

contents thereof, are forbidden without express authority. Offenders are liable to the payment

of damages. All rights are reserved in the event of a patent grant or registration of a utility

model or design. All specification supplied herein are subject to change without notice at any

time.

Copyright © Quectel Wireless Solutions Co., Ltd. 2012

Document Title Firmware Upgrade Tool Advanced WS1 User Guide

Version 1.0

Date 2012-04-28

Status Released

Document Control ID Firmware_Upgrade_Tool_Advanced_WS1_V1.0

Quectel

Confidential



Contents

Contents ............................................................................................................................................ 2

Figure Index ...................................................................................................................................... 3

0. Revision history ............................................................................................................................ 4

1. Introduction ................................................................................................................................... 5

2. Tool installation ............................................................................................................................. 6

3. Firmware ....................................................................................................................................... 7

4. Introduction to the tool .................................................................................................................. 8

4.1. UI settings ........................................................................................................................... 9

4.1.1. Port configuration ...................................................................................................... 9

4.1.2. Files setting ............................................................................................................. 10

4.1.3. Database file setting ................................................................................................ 11

4.1.4. Operation option ...................................................................................................... 12

4.2. Firmware upgrade ............................................................................................................. 13

4.2.1. Backup system data ................................................................................................. 13

4.2.2. Download FW and format ....................................................................................... 16

4.2.3. Restore system data ................................................................................................. 18

4.2.4. Stop ......................................................................................................................... 19

4.3. Abnormalities .................................................................................................................... 19

Quectel

Confidential



Figure Index

FIGURE 1: THE MAIN INTERFACE ..................................................................................................... 8

FIGURE 2: UI OF PORT ......................................................................................................................... 9

FIGURE 3: UI OF BAUD RATE ........................................................................................................... 10

FIGURE 4: UI OF CFG FILE: FILE OPEN WINDOW ........................................................................ 10

FIGURE 5: UI OF CFG FILE SELECTED ........................................................................................... 11

FIGURE 6: UI OF SET OLD FILE WINDOW OPEN .......................................................................... 11

FIGURE 7: UI OF SET NEW FILE WINDOW OPEN ......................................................................... 12

FIGURE 8: UI OF OPERATE OPTION ................................................................................................ 13

FIGURE 9: BACKUP SYSTEM DATA-1 ............................................................................................. 14

FIGURE 10: BACKUP SYSTEM DATA-2 ........................................................................................... 15

FIGURE 11: BACKUP SYSTEM DATA-3 ........................................................................................... 15

FIGURE 12: DOWNLOAD FW AND FORMAT-1 ............................................................................... 16




FIGURE 16: RESTORE SYSTEM DATA ............................................................................................. 18

FIGURE 17: SELECT THE BACKUP FILE FROM STEP BACKUP SYSTEM DATA ...................... 18

FIGURE 18: RESTORE SYSTEM DATA SUCCESS ........................................................................... 19

FIGURE 19: UI OF BLANK PORT ERROR ........................................................................................ 20

FIGURE 20: UI OF BUSY PORT ERROR ............................................................................................ 20

FIGURE 21: UI OF BAUD RATE ERROR ........................................................................................... 21

FIGURE 22: UI OF UPGRADE WITH INCORRECT CFG FILE ........................................................ 21

FIGURE 23: UI OF BACKUP SYSTEM DATA ERROR WHEN CANCEL TO SAVE FILE ........... 22

FIGURE 24: UI OF RESTORE SYSTEM DATA ERROR WHEN CANCEL TO SAVE DATA .......... 22

FIGURE 25: UI OF BACKUP SYSTEM DATA ERROR WHEN POWER SUPPLY ABNORMAL ... 23

FIGURE 26: UI OF POWER SUPPLY OR USB ABNORMAL IN DA PROCESS .............................. 23

FIGURE 27: UI OF POWER SUPPLY OR USB ABNORMAL IN DOWNLOAD PROCESS ............ 24

FIGURE 28: UI OF POWER SUPPLY ABNORMAL IN FORMAT PROCESS .................................. 24

FIGURE 29: UI OF USB ABNORMAL IN RESTORE SYSTEM DATA PROCESS........................... 25

FIGURE 30: UI OF POWER SUPPLY OR USB ABNORMAL WHEN READ SYSTEM DATA TO

TERMINAL ..................................................................................................................... 25

FIGURE 31: UI OF ERROR WHEN FAIL TO SAVE SYSTEM DATA ............................................... 26

FIGURE 32: UI OF ERROR WHEN FAIL TO RESTORE SYSTEM DATA ....................................... 26

Quectel

Confidential



0. Revision history

Revision Date Author Description of change

V1.0 2012-04-21 Lucky DOU Initial

Quectel

Confidential



1. Introduction

This document describes how to upgrade firmware using “Firmware Upgrade Tool Advanced

WS1” supplied by Quectel.

This tool can be used to download firmware and format flash, and also can backup and restore

system data of the module, such as IMEI, SN, and calibration data etc.

Quectel

Confidential



2. Tool installation

The tool can run smoothly without any installations as long as the OS of PC is among the ones listed

below.

Windows 95

Windows 98

Windows 2000

Windows ME

Windows XP

Quectel

Confidential



3. Firmware

The firmware package for one version contains one folder and one database file.

The folder includes the firmware image file and related configure file (.cfg file). The .cfg file is set

in this tool and used to download the firmware.

The database file’s name begins with “BPLG…”. Below is the database file for version

U10AR02A03M1024:

“BPLGUInfoCustomAppSrcP_MT6276_S01_U10AR02A03M1024”.

When the module is upgraded from the old (current) firmware to the new (target) firmware, the

database for old firmware is used to backup the system data, and the database for new firmware is

used to restore the system data.

Quectel

Confidential



4. Introduction to the tool

The tool is used to upgrade firmware for the U10 module.

Double click the tool icon, and then the tool is opened with the main interface shown as Figure 1.

Figure 1: The main interface

It works as following steps:

Step1: Choose the correct serial port and baud rate in “Config” area.

Step2: Select the .cfg file for the target (new) firmware in “Files Setting” area.

Step3: Select correct old database file in “Backup Database”.

Step4: Select correct new database file in “Restore Database”.

Step5: Select three options “Backup System Data”, “Download FW and Format” and “Restore

System Data” in “Operate Option” area.

Step6: Click Start button to start backup system data.

Step7: Power off and on the module when getting prompt “Please re-start the terminal” in

Backup Data Process.

Step8: Power off and on the module again when getting prompt “Please re-start the terminal” in

Download Process.

Step9: Power off and on the module again when getting prompt “Please re-start the terminal” in

Restore Process.

The following describes the details on how to use the upgrade tool.

Quectel

Confidential



4.1. UI settings

4.1.1. Port configuration

A) Port

According to the connection between PC and Module, select the right serial port as Figure 2.

Figure 2: UI of Port

B) Baud rate

Choose an appropriate baud rate. Please refer to Figure 3.

Note:

1. The maximal baud rate of standard serial cable is 115200, and the USB-Serial cable is

460800.

2. Only the MAIN port can be used to upgrade the firmware. The USB virtual port cannot be

used in this tool.

Quectel

Confidential



Figure 3: UI of Baud Rate

C) Get debug log file

It can be ignored.

D) Flash type

It can be ignored.

4.1.2. Files setting

Click Set CFG button to select the .cfg file for the new firmware. The tool will match the .bin file

in the same folder automatically after selected correct .cfg file. Dialogue frames are shown in

Figure 4 & Figure 5.

Figure 4: UI of CFG File: File Open window

Quectel

Confidential



Figure 5: UI of CFG File Selected

4.1.3. Database file setting

Click Set Old button to select the backup database file to match with the current firmware.

Click Set New button to select the restore database file to match with the target firmware.

Dialogue frames are shown in Figure 6 and Figure 7.

Note:

The tool can also work successfully even through an incorrect database file was selected, but

there could be some ERRORs when backuping or restoring system data. So, it is very

important to select the correct database file to match with the current or target firmware in

the module.

Figure 6: UI of Set Old File Window Open

Quectel

Confidential



Figure 7: UI of Set New File Window Open

4.1.4. Operation Option

Backup System Data:

Enable/Disable to select whether to backup system data or not.

Download FW and Format:

Enable/Disable to select whether to download FW and format or not.

Restore System Data:

Enable/Disable to select whether to restore system data or not.

Note:

1. All options are checked by default. Please refer to Figure 8.

2. Items should be executed in order, but can be single selected or combined with next, such as

A and B, or B and C.

3. It is recommended to do these operations one by one, i.e., select one item and click “Start” to

finish it, then select the next item and click “Star”. The next part will show each step as

example.

Quectel

Confidential



Figure 8: UI of Operate Option

4.2. Firmware Upgrade

There are log and indication area, progress bar, Start button and Stop button on the right area of

the tool. The progress bar indicates the progress of upgrading firmware and shows the time expire

of upgrading.

There are several steps in the progress of upgrading firmware:

Backup System Data

Download FW and Format

Restore System Data

Three options can be selected together or separately. The following is taken the each selection as

example.

4.2.1. Backup System Data

1. Select “Backup System Data” option, click the “Start” button. Please refer to Figure 9.

2. When it prompts “Please re-start the terminal.” in the log area, re-start the terminal to start

backuping the system data.

3. When it finished, it will pop up a “Save as” window. Please select the directory and input file

name which is used to save the system data. Please refer to Figure 10.

4. It will indicate “Mission Accomplish. Pass.” if backup is successful as shown in Figure 11.

Quectel

Confidential



Figure 9: Backup System Data-1

Quectel

Confidential





Quectel

Confidential



4.2.2. Download FW and Format

The “Download FW and Format” progress dialogue frames are shown in Figure 12, 13, 14 and

Figure 15.

Select “Download FW and Format” and click “Start” button, when it prompts “Please re-start the

terminal”, restart the module and then it will begin to download the firmware and format.

Figure 12: Download FW and Format-1


Quectel

Confidential





Quectel

Confidential



4.2.3. Restore system data

Dialogue frames of the “Restore System Data” progress are shown in Figure 16, 17 and Figure 18.

Select “Restore System Data” and click “Start” button, when it prompts “Please re-start the

terminal”, restart the module. When the “Open” window pops up, select the backup system data

file saved in step “Backup System Data”.

Figure 16: Restore System Data

Figure 17: Select the backup file from step Backup System Data

Quectel

Confidential



Figure 18: Restore System Data success

Note:

1. To make sure the tool runs successfully, following preparations must be done in advance:

Link PC and module correctly

Choose the correct serial port and baud rate

Choose the right .cfg file to be upgraded

Choose the correct Database File

Re-start Terminal if prompt appears.

2. When all three steps are selected and run together, the system data file will be saved

automatically in the “CalData”folder under the installation directory, and it will be opened

automatically when restoring the system data. If some error occurs and it needs to restore

system data again, please select this data file.

4.2.4. Stop

Click the Stop button to stop upgrading.

Warning:

If the upgrade process is interrupted, there would be no valid firmware in the module. So it is

never recommended to stop the firmware upgrade process.

4.3. Abnormalities

The wrong parameter of Port and Baud rate, the damaged EVB and module, the incorrect file, etc.

may lead to abnormalities as following.

A) Wrong parameter of Port

Quectel

Confidential



Figure 19: UI of Blank Port ERROR

Figure 20: UI of Busy Port ERROR

B) Wrong parameter of Baud Rate

Quectel

Confidential



Figure 21: UI of Baud Rate ERROR

C) Upgrade with Incorrect File

Figure 22: UI of Upgrade with Incorrect CFG File

Quectel

Confidential



Figure 23: UI of Backup System Data ERROR when Cancel to Save File

Figure 24: UI of Restore System Data ERROR when Cancel to Save Data

A) Power supply or USB Abnormal

Quectel

Confidential



Figure 25: UI of Backup System Data ERROR when Power Supply Abnormal

Figure 26: UI of Power Supply or USB Abnormal in DA Process

Quectel

Confidential



Figure 27: UI of Power Supply or USB Abnormal in Download Process

Figure 28: UI of Power Supply Abnormal in Format Process

Quectel

Confidential



Figure 29: UI of USB Abnormal in Restore System Data Process

Figure 30: UI of Power Supply or USB Abnormal When Read System Data to Terminal

Quectel

Confidential



Figure 31: UI of ERROR when Fail to Save System Data

Figure 32: UI of Error when Fail to Restore System Data

Quectel

Confidential

Shanghai Quectel Wireless Solutions Co., Ltd.

Room 501, Building 13，No.99 Tianzhou Road, Shanghai, China, 200233

Tel: +86 21 5108 6236

Mail: [email protected]

mailto:[email protected]

Quectel Cellular Engine€¦ · FW_Upgrade_Tool_Advanced_WS1_UGD_V1.0 -12 - Figure 7: UI of Set New...

Documents

Transcript of Quectel Cellular Engine€¦ · FW_Upgrade_Tool_Advanced_WS1_UGD_V1.0 -12 - Figure 7: UI of Set New...