Sei sulla pagina 1di 20

Qualcomm Flash Image Loader (QFIL)

User Guide
80-NN120-1 A
March 19, 2014

Submit technical questions at:


https://support.cdmatech.com/

Confidential and Proprietary – Qualcomm Technologies, Inc.


NO PUBLIC DISCLOSURE PERMITTED: Please report postings of this document on public servers or websites
to: DocCtrlAgent@qualcomm.com.

Restricted Distribution: Not to be distributed to anyone who is not an employee of either Qualcomm or its
subsidiaries without the express approval of Qualcomm’s Configuration Management.

Not to be used, copied, reproduced, or modified in whole or in part, nor its contents revealed in any manner to others
without the express written permission of Qualcomm Technologies, Inc.

Qualcomm reserves the right to make changes to the product(s) or information contained herein without notice. No
liability is assumed for any damages arising directly or indirectly by their use or application. The information
provided in this document is provided on an “as is” basis.

This document contains confidential and proprietary information and must be shredded when discarded.

Qualcomm is a trademark of QUALCOMM Incorporated, registered in the United States and other countries. All
QUALCOMM Incorporated trademarks are used with permission. Other product and brand names may be
trademarks or registered trademarks of their respective owners.

This technical data may be subject to U.S. and international export, re-export, or transfer (“export”) laws. Diversion
contrary to U.S. and international law is strictly prohibited.

Qualcomm Technologies, Inc.


5775 Morehouse Drive
San Diego, CA 92121
U.S.A.

© 2014 Qualcomm Technologies, Inc.


All rights reserved.
Contents

1 Introduction...................................................................................................... 6
1.1 Purpose.......................................................................................................................... 6
1.2 Scope............................................................................................................................. 6
1.3 Conventions .................................................................................................................. 6
1.4 References..................................................................................................................... 7
1.5 Technical assistance ...................................................................................................... 7
1.6 Acronyms ...................................................................................................................... 7

2 Operation Guide .............................................................................................. 8


2.1 Build organization......................................................................................................... 9
2.2 Download flat build image............................................................................................ 9
2.3 Download meta build image ....................................................................................... 13
2.4 Flat meta build ............................................................................................................ 16
2.5 Backup and restore QCN ............................................................................................ 17
2.6 Advanced settings ....................................................................................................... 17
2.7 Save and clear log ....................................................................................................... 18

3 Command Line Argument Description ........................................................ 19


3.1 Format ......................................................................................................................... 19
3.2 Attributes .................................................................................................................... 19

80-NN120-1 A 2 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Contents

Figures
Figure 2-1 QFIL window .............................................................................................................................. 8
Figure 2-2 Download flat build image flow.................................................................................................. 9
Figure 2-3 Select port dialog....................................................................................................................... 10
Figure 2-4 Select programmer (sahara download area) dialog ................................................................... 11
Figure 2-5 Select build (select search path) dialog ..................................................................................... 11
Figure 2-6 Load raw program XML files dialog ....................................................................................... 12
Figure 2-7 Load patch XML files dialog ................................................................................................... 12
Figure 2-8 Download XML files dialog .................................................................................................... 13
Figure 2-9 Download meta build image flow ............................................................................................ 14
Figure 2-10 Select contents.xml file dialog ............................................................................................... 15
Figure 2-11 Download content dialog ....................................................................................................... 15
Figure 2-12 Flat meta build button location............................................................................................... 16
Figure 2-13 Flat meta build dialog............................................................................................................. 16
Figure 2-14 Select a raw program file for flat build file list ...................................................................... 16
Figure 2-15 QCN backup and restore dialog ............................................................................................. 17
Figure 2-16 Advanced settings dialog ....................................................................................................... 17
Figure 2-17 Save and clear log .................................................................................................................. 18

80-NN120-1 A 3 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Contents

Tables
Table 1-1 Reference documents and standards ............................................................................................ 7
Table 3-1 Attributes list ............................................................................................................................. 19

80-NN120-1 A 4 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Revision history

Revision Date Description


A March 2014 Initial release
Note: There is no Rev. I, O, Q, S, X, or Z per Mil. standards.

80-NN120-1 A 5 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
1 1 Introduction

2 1.1 Purpose
3 This guide describes how to use the component application of the Qualcomm Flash Image Loader
4 (QFIL) software. QFIL is integrated in QPST; QPST version must be QPST 2.7 build 416 or
5 above. After installing QPST, QFIL is installed.

6 1.2 Scope
7 This user guide is written for technicians, administrators, and other people who operate QFIL.

8 1.3 Conventions
9 Function declarations, function names, type declarations, and code samples appear in a different
10 font, e.g., #include.
11 Code variables appear in angle brackets, e.g., <number>.
12 Commands to be entered appear in a different font, e.g., copy a:*.* b:.
13 Button and key names appear in bold font, e.g., click Save or press Enter.
14 If you are viewing this document using a color monitor, or if you print this document to a color
15 printer, red typeface indicates data types, blue typeface indicates attributes, and green typeface
16 indicates system attributes.
17 Parameter types are indicated by arrows:
 Designates an input parameter
 Designates an output parameter
 Designates a parameter used for both input and output

18

19 Shading indicates content that has been added or changed in this revision of the document.
20

80-NN120-1 A 6 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Introduction

1 1.4 References
2 Reference documents are listed in Table 1-1. Reference documents that are no longer applicable
3 are deleted from this table; therefore, reference numbers may not be sequential.

4 Table 1-1 Reference documents and standards

Ref. Document

Qualcomm Technologies
Q1 Application Note: Software Glossary for Customers CL93-V3077-1
Q2 Qualcomm Product Support Tool (QPST™) 2.7 User Guide 80-VL1400-3
5

6 1.5 Technical assistance


7 For assistance or clarification on information in this document, submit a case to Qualcomm
8 Technologies, Inc. (QTI) at https://support.cdmatech.com/.
9 If you do not have access to the CDMATech Support Service website, register for access or send
10 email to support.cdmatech@qti.qualcomm.com.

11 1.6 Acronyms
12 For definitions of terms and abbreviations, see [Q1].

80-NN120-1 A 7 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
1 2 Operation Guide

2 This tool (QFIL) can be used to flash a build image into a target in the Emergency Download
3 (EDL) mode or from High Level OS (HLOS) mode (normal boot up).
4 Usually the target is in emergency download when no image is present on the target or when the
5 image is corrupted. In such situation, the target will be enumerated as “Qualcomm HS-USB
6 QDLoader …” when connected to a PC via USB.
7 When a phone is boot up normally and HLOS is running, the target will be enumerated as
8 “Qualcomm HS-USB Diagnostics …” or alike when connected to a PC via USB. In this
9 situation, QFIL will automatically switch target to EDL mode and then load the build into the
10 phone.
11 Before starting, follow [Q2] to install QPST.
12 1. Connect phone to PC.
13 2. Run QFIL, the QFIL window shows as below:

14

15 Figure 2-1 QFIL window

80-NN120-1 A 8 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 2.1 Build organization


2 In order for the tools to work, the images can be organized in one of the following two ways:
3  Flat build: all the images are in one single folder
4  Meta build: the images are scattered in specific folders following the meta build structure
5 In the next sections, the two procedures to flash the build depending on how they are organized
6 are explained.

7 2.2 Download flat build image


8 In the flat build, all the images for the target platform are included in one single folder together
9 with the partition files.
10 Partition files are files named rawprogramX*.xml and patchX.xml, where X is a number.
11 Usually they are located inside the meta build folder, at the following path:
12

13 common\build\<type> //<type> is eMMC


14

15 Normally, this folder does not contain binary images for the build, so the customer needs to move
16 all the images binaries to this folder if this is the chosen way of using the tool.
17 The instructions below are steps to flash this kind of build:

4
5

18

19 Figure 2-2 Download flat build image flow

20

80-NN120-1 A 9 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 1. Click “Select Port …” button to change the port.


2 Select “Show Non Diagnostic Port” to show a port without “Diagnostic” or “QDLoader” in
3 description.

5 Figure 2-3 Select port dialog

6 If the “-COM” is set; QFIL will detect the existence of the setting port; Otherwise, QFIL will
7 detect the port first inserted. “-COM” setting methods refer to Chapter 3.
8 2. Click “Browse…” to select firehose programmer MBN file. The programmer is usually
9 located in the folder (from boot build):
10

11 \boot_images\build\ms\bin\<msm>\
12

13 Where the <msm> is the platform name (e.g. 8084). The name of firehose programmer is:
14

15 prog_<type>_firehose_<msm>.mbn
16

17 where type can be “emmc” or “ufs” and <msm> is the platform name (e.g. 8084) .

80-NN120-1 A 10 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

2 Figure 2-4 Select programmer (sahara download area) dialog

3 NOTE: Once selected file, “Select Build Search path” text box in the GUI will be updated with the
4 location of this programmer. You can also follow Step 3 below to change the search path.

5 The programmer is downloaded before downloading an image, if the programmer is not a


6 firehose programmer, the image downloading is not working. The firehose settings refer to
7 Section 2.6.
8 3. (Optional) Click “Browse…” to select build. The build path is for both configuration file
9 (.xml) and image binary file; the configuration file list is cleaned up once the path is changed.

10

11 Figure 2-5 Select build (select search path) dialog

80-NN120-1 A 11 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 4. Click “Load XML…” to load configuration file.


2 a. First, multi-select the raw program XML files in the dialog box, and click “Open”.

4 Figure 2-6 Load raw program XML files dialog

5 b. Then, multi-select the patch XML files, and click “Open”.

7 Figure 2-7 Load patch XML files dialog

8 5. Click “Download” button to start download.


9 During downloading, all the buttons are dim and invalid. When the progress bar comes to
10 end, the phone is rebooting and QFIL will wait a few minutes until boot process is done or
11 timeout.

80-NN120-1 A 12 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

2 Figure 2-8 Download XML files dialog

3 6. Once click the Download button, all the function buttons will be dimmed. And they are re-
4 enabled after downloading is finished. Once a downloading comes to the end, the phone is
5 rebooting and the tool will wait until boot process is done or timeout, it may take few minutes

6 2.3 Download meta build image


7 In this section, the build is organized using the meta build (the release not of the specific platform
8 will guide through setting up the meta build folder structure). This means that a file name
9 contents.xml is stored in the build root, and this file contains the path to the other images.
10 Before flashing a build using the meta build, make sure that you have generated the sparse images
11 for the build. In order to do that, follow these steps:
12  Compile all the subsystem.
13  Run the file common\build\update_common_info.py
14 At the end of this procedure, several files will be generated in the folder:
15

16 common\build\<type>\bin\<target>\sparse_images
17

18 <type> = “emmc” or “ufs”, <target> = “asic” or “virtio”


19 Make sure the files are generated in this folder, otherwise the below procedure will fail.
20

80-NN120-1 A 13 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 The instructions below are the steps to flash this kind of build:

3 Figure 2-9 Download meta build image flow

4 1. Select port
5 See Step 1 in Section 2.2 .
6 2. Select programmer
7 See Step 2 in Section 2.2 .
8 3. Click on “Download Content…” button
9 A new dialog is opened to select the file contents.xml. This file is usually placed in the
10 root folder of the build. Make sure that this file is updated with the path to all the subsystem
11 images.

12 NOTE: The “Download Content…” button is not available until selecting a firehose programmer.

80-NN120-1 A 14 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

2 Figure 2-10 Select contents.xml file dialog

3 QFIL starts downloading, as shown in Figure 2-11 .

5 Figure 2-11 Download content dialog

80-NN120-1 A 15 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 Once a download started, all the function buttons will be dimmed. And they are re-enabled
2 after downloading is finished. Once a downloading comes to the end, the phone is rebooting
3 and the tool will wait until boot process is done or timeout, it may take few minutes.

4 2.4 Flat meta build


5 1. Navigate to menu: Tools  Flat Meta Build.

1
6

7 Figure 2-12 Flat meta build button location

8 2. Click “Browse…” to select a contents.xml file of meta build.


9 3. Click “Browse…” to select a folder path to store the flatten build.

2
3

10

11 Figure 2-13 Flat meta build dialog

12 4. (Optional) Select a raw program file for flat build file list. The default raw program file path
13 is got from contents.xml and will be used when the path is empty.

14

15 Figure 2-14 Select a raw program file for flat build file list

80-NN120-1 A 16 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1 2.5 Backup and restore QCN


2 1. Navigate to menu: Tools  QCN Backup Restore.
3 2. (Optional) Click “Browse…” to change QCN file path, and click “Backup QCN” button to
4 backup QCN from phone.
5 3. (Optional) Click “Browse…” to change QCN file path, and click “Restore QCN” to restore
6 QCN into the phone.
7 The QCN backup and restore setting refer to Section 2.6.

1
2
3
8

9 Figure 2-15 QCN backup and restore dialog

10 2.6 Advanced settings

11

12 Figure 2-16 Advanced settings dialog

13 Firehose setting:
14  Max Payload Size in Byte to Target: the maximum payload size in byte send to target phone
15 for each packet.
16  Device Type and Platform: the flash type and platform.
17  Ack Raw Data Settings: Once the option is enabled, the phone will send a response once
18 every N packet(s) are sent.

80-NN120-1 A 17 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Operation Guide

1  Always Validate: Enable the option to always validate the data programming which is written
2 to flash.
3 Backup and restore QCN setting:
4  Auto Backup and Restore QCN: Enable the option to backup QCN before download is started
5 and restore DCN after download and reboot. The option is invalid when the phone is initially
6 in EDL (QDLoader) mode.
7  SPC Code: SPC code for backup QCN, default is “000000”.

8 2.7 Save and clear log


9 After downloading the build image, right-click the status box, you can select to save or clear log.

10

11 Figure 2-17 Save and clear log

12

80-NN120-1 A 18 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
1 3 Command Line Argument Description

2 Type the command line in cmd.exe to quick setting the parameters, for example:
3 qfil.exe -Mode=1 -COM=64 -SEARCHPATH="D:\CBW8600A01_A_T1701"
4 -Sahara=true;"D:\CBW8600A01_A_T1701\prog_emmc_FireHose_8x26.mbn"
5 -RawProgram=rawprogram_unsparse.xml,rawprogram2.xml
6 -patch=patch0,patch2.xml -AckRawDataEveryNumPackets=TRUE;100
7 -DeviceTYPE="eMMC" -PlatForm="8x26" -MaxPayloadSizeToTargetInBytes="49152"

8 3.1 Format
9 Format: -XXX=YYY;ZZZ
10  -XXX: Attribute
11  YYY;ZZZ: Values, separated by “;”, space is not available.

12 3.2 Attributes
13 All the attributes are listed in Table 3-1.

14 Table 3-1 Attributes list


Parameter Description Value
-Mode Mode setting 0 - Normal Mode
1 - Debug Mode
2 - Background Mode (TBD)
-COM Comport number setting
-SAHARA Enable Sahara Download and Enabled: true\false
include the programmer path, the Path: programmer full path
format is:
-SAHARA=enabled;path
-SearchPath Image binary file search path, only
used for firehose download, it’s also
the search path for raw program and
patch XML file, only one search is
available
-RawProgram Raw program XML file name, can be
multiply files, separated by comma
-Patch Patch XML file name, can be
multiply files, separated by comma

80-NN120-1 A 19 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
Command Line Argument Description

Parameter Description Value


-AckRawDataEveryNumPackets Ack raw data every number packets Enable: true\false
setting, if the setting is enabled, Number: ack number
phone will send response once settings
every multiply of setting packets, the
format is:
-AckRawDataEveryNumPackets =
enable;number
-MaxPayloadSizeToTargetInBytes Max payload size to target in bytes
setting, define the payload size in
byte for each packet
-DeviceType Device type setting eMMC
-Platform Qualcomm platform setting

80-NN120-1 A 20 Confidential and Proprietary – Qualcomm Technologies, Inc.


MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION

Potrebbero piacerti anche