Firmware Update Application Note...Firmware Over The Air (FOTA) technology, ensuring that embedded...

11
GSM Quectel Cellular Engine Firmware Update Application Note Fw_Update_Application_Note_V3.1

Transcript of Firmware Update Application Note...Firmware Over The Air (FOTA) technology, ensuring that embedded...

GSM Quectel Cellular Engine

Firmware Update

Application Note Fw_Update_Application_Note_V3.1

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -1-

Document Title Firmware Update Application Note

Version 3.1

Date 2012-03-08

Status Released

Document Control ID Fw_Update_Application_Note_V3.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 for customers of Quectel. Quectel has not undertaken any

independent search for additional information, relevant to 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 of Quectel Co., Ltd. Copying this

document, distribution to others, and communication of the contents thereof, are forbidden without

permission. 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 specifications supplied herein are

subject to change without notice at any time.

Copyright © Quectel Wireless Solutions Co., Ltd. 2012.

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -2-

Contents

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

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

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

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

1.1. Reference ............................................................................................................................. 5

2. Preliminary requirements .............................................................................................................. 6

3. Download update firmware ........................................................................................................... 7

4. Upgrade process ............................................................................................................................ 8

4.1. Restart the module ............................................................................................................... 8

4.2. Synchronizing and upgrading .............................................................................................. 8

4.3. Complete upgrading ............................................................................................................ 9

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -3-

Figure Index

FIGURE 1: UART CONNECTION ......................................................................................................... 6

FIGURE 2: FOTA PROCESS .................................................................................................................. 7

FIGURE 3: RESTART THE MODULE ................................................................................................... 8

FIGURE 4: SYNCHRONIZING AND UPGRADING PROCESS .......................................................... 9

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -4-

0. Revision history

Revision Date Author Description of change

3.0 2012-02-28 Stanley YONG Initial

3.1 2012-03-08 Stanley YONG 1. Added the information about the

applied scope of the firmware

update solution for Quectel

modules.

2. Optimized Figure 1.

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -5-

1. Introduction

This document provides fast, secure and reliable way for wirelessly upgrading Firmware using

Firmware Over The Air (FOTA) technology, ensuring that embedded software is up-to-date with

the latest enhancement and features.

This document illustrates the firmware update solution for M10 R2.0, M12 R2.0, M72 2.0, M80,

and M95 modules.

1.1. Reference

Table 1: Reference

SN Document name Remark

[1] Fw_Update_Protocol_AN_V1.2 Firmware update protocol application notes

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -6-

2. Preliminary requirements

In order to benefit from the firmware update service, the following requirements must be fulfilled:

UART connection

Figure 1: UART connection

The external application transfers update firmware to the module through MAIN serial port (i.e.

UART1 port).

The UART1 configuration is as below:

Baud rate: 115200

Data bit: 8

Stop bit: 1

Parity: None

Flow control: Disabled

SIM internet connection

The SIM needs to have enabled internet connection.

External MCU

Module RX

TX

GND

TX

RX

GND

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -7-

3. Download update firmware

Before updating, the external application has to download update firmware, which is the new

firmware version, from customer server through GPRS network. Built-in HTTP, TCP/UDP, FTP,

Quectel module offers multiple options for the external application to download update firmware.

Figure 2: FOTA process

The update firmware downloaded from server will be stored in external storage, such as external

Flash.

Terminal

Device

GPRS

(HTTP,TCP/

UDP, FTP)

Quectel

Module

Ext.

MCU

Ext.

Memory

Server

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -8-

4. Upgrade process

In order to start upgrade process, the external application has to synchronize with the module at

the startup procedure of the module. Please refer to the document [1] to get extended information

about the time sequence for synchronization.

4.1. Restart the module

To reset the module, the external MCU may control the level of PWRKEY. Please refer to the

related HD document for the time sequence of switching on or off.

Figure 3: Restart the module

4.2. Synchronizing and upgrading

To start upgrade process, the external application has to continuously send some synchronization

words ‘5B’ and ‘9A’ till the module respond with ‘B5’ and ‘A9’ at the startup procedure of the

module.

External MCU

Module

PWRKEY GPIO

Quectel

Confidential

Firmware Update Application Note

Fw_Update_Application_Note_V3.1 -9-

Figure 4: Synchronizing and upgrading process

4.3. Complete upgrading

After the external application finishes the data transmission, the new firmware is updated to the

image bin region in Flash. At this time, the external application may send end command to end

upgrading and let the module run the new firmware program.

Please refer to the document [1] to get detailed information.

External

MCU

Module

SYNC_WORD (B5)

SYNC_WORD_ACK (5B)

SYNC_WORD (A9)

SYNC_WORD_ACK (9A)

Start to transfer update firmware…

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]