QUuALCOMW: Qualcomm Technologies, Inc QXDM Professional™ v4 for Windows OS User Guide 80-V1241-25 C January 25, 2017 Confidential and Proprietary — Qualcomm Technologies, ne. No PUBLIC DISCLOSURE PERMITTED: Please report postings ofthis document on public servers or websites to: DocCtiAgent@qualeomm.com. Restricted Distribution: Notto be distributed to anyone whois not an employee of ether Qualeomm Technologies, Inc. oF {fated companies without the express approval of Gualeomm Configuration Management. Nott be used, copied, reproduced, oF motifed in whole orn part, nor ts contents revealed in any manne! to others without the ‘2:pess written permission of Qualcomm Technologies, Inc (Qx0M Professionals 2 product of Qualcomm Technologies, Ine. Other Qualeomm products referenced herein are products of ‘Qualcomm Technologies Ine. or subsigiares. Qualcomm and QXDM Professional are tradema&s of Qualcomm Incorporate, registered inthe United States and other counties ‘Other product and Brand names may be tradematke of registered ademais of thelr respective owners “This technical data may be subject to U.S. and international export, re-export, or transfer export’ lans. Diversion contrary to U.S. and international lav stity prohibited Qualcomm Technologies ne. ‘5775 Morehouse Drive ‘San Diego, CAG2121 USA (© 2016-2017 Qualcomm Technolgies, Ino. Allrighs reserved,Revision history Revision Date Description A September 2015 _| Initial release 5 March 2016 | Added the manage configuration option in Sedion 3.1; added Sections 3.3.3 and 3.35; updated the graph viewimage e Januaty2017__ | Numerous changes have been made to this document, should be read itits entirety eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONContents 1 Introduction. 8 1.1 Purpose 8 8 8 1.2 Conventions 1.3 Technical assistance 2 Installation... 2.1 Required hardware and software 9 2.2 Installing QXDM Pro. 10 2.3 Physical connectivity nN 2.4 QRDM Fro documentation 1 2.5 Ttem store format (isf) files n 3 Menu overview.. 3.1 File mena 3.1.1 Annotation 3.1.2 Manage Configuration 3.1.3 Load Configuration. 3.14 Save Sonfiguration. 3.1.5 Load Default Configuration 3.1.6 Open 3.1.7 New Items 3.1.8 Save Items 3.1.9 Replay Items 3.1.10 Item Store Settings 3.1.11 Recent Data File 3.1.12 Recent Configuration. 3.1.13 Exit 3.2 View menu. 3.2.1 Item View 3.2.2 Filtered View 3.2.3 NV Browser 3.3 Options menu. 3.3.1 Communications 3.3.2 Settings 3.3.3 Dip Switch 3.34 Reset Target 3.315 Set Target Offline 3.3.6 Refresh Target 3.3.7 Reset Application Settings 3.3.8 Load QShrinks database eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. 3 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ vé for Windows OS User Guide 3.3.9 Parsing option. 3.4 Tools menu 3.4.1 CFG File Generator 3.4.2 Database Editor 3.4.3 PPP Extractor 3.5 Window menu 3.51 Clear All 3.5.2 Cascade 3.5.3 Minimize All 3.54 Restore All 3.55 Tile Horizontal 3.5.6 Close 3.5.7 Close All 3.5.8 Auto Scroll All 3.5.9 Previous Window. 3.5.10 Next Window. 3.6 Help menu. 3.61 Licensing 3.6.2 About QXDM Professional 4 Icons & Indicators 4.1 Command. 4.1.1 Command functions 4.2 Quick Search, 4.3 Status bar 5 COM Automation Interfaces .. Contents 5.1 QXDM Pro interface. 50 5.1.1 AppVersion, 50 5.1.2 ClearViewltems 50 5.1.3 COMPort 50 5.1.4 CopyViewltems 50 5.1.5 CloseView 51 5.1.6 CreateView 51 5.1.7 DipSwitchMask. 51 5.1.8 ExportViewText 52 5.1.9 IsPhoneConnected 52 5.1.10 LoadConfig. 52 5.1.11 LoadltemStore 52 5.1.12 LogMask 53 5.1.13 LogMaskOff 53 5.1.14 LogMaskOn. 53 5.1.15 OfflineDigital 53 5.1.16 ResetPhone 53 5.1.17 SaveConfig 53 5.1.18 SendDmledPacket. 54 5.1.19 SendDmledPacketEx. 54 5.1.20 SendScript 54 5.1.21 SetCDMAProtocolRevision 54 eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. 4 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ vé for Windows OS User Guide Contents 5.1.22 SetWCDMAProtocolRevision. 55 5.1.23 SaveltemStore 55 5.1.24 SetLoggingOn 56 5.1.25 SetLoggingOnE x 56 5.1.26 SetLoggingOft 56 5.1.27 QuitApplication. 56 5.1.28 QXDMTextOut 56 5.1.29 Visible 57 5.1.30 WaitEvent 51 5.1.31 Requestitem. 51 5.1.32 RemoveRequest 58 5.1.33 GetServerState 58 5.1.34 GetltemCount 59 5.1.35 Getltem 50 5.1.36 RegisterClient 59 5.1.37 RegisterQueueClient 59 5.1.38 UnregisterClient 60 5.1.39 ConfigureClientB yKeys 60 5.1.40 ConfigureClientB yNames 60 5.141 ClearClientltems 61 5.1.42 GetClientltemCount 61 5.143 GetClientltem 61 5.1.44 ClientRequestltem a 5.145 ClientRemoveRequest 63 5.146 ClientRequestNVRead. 63 5.147 ClientRequestNV Write 64 5.1.48 CopyClientltems 64 5.1.49 SyncToltem. 65 5.1.50 SyncToClientitem. 65 5.1.51 ClientRequestNVName 65 5.2 Client Config interface (IClientConfig) 65 5.2.1 ClearConfig 65 5.2.2 CommitConfig 66 5.2.3 Addltem, 66 5.24 AddDIAGRequest 66 5.2.5 AddDIAGResponse 67 5.2.6 AddSubsysRequest 67 5.2.7 AddSubsysResponse 68 5.28 AddEvent 69 5.2.9 AddLog 69 5.2.10 AddMessage 70 5.2.11 AddString 10 5.2.12 AddOTALog n 5.2.13 AddOTALogByString B 5.3 Item interface (IColoritem) B 5.311 GetltemType B 5.3.2 GetltemTypeText 4 5.3.3 GetltemColor 4 5.34 GetltemTimestamp 4 5.35 GetltemTimestamp? 4 sovias2s.¢ Confidential and Proprietary — Qualcomm Technolgies. ne. 5 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ v4 for Windows OS User Guile Contents 5.3.6 GetltemTimestampText 5 5.317 GetltemSpecificTimestamp B 5.38 GetltemSpecificTimestamp? B 5.39 GetltemSpecificTimestamp Text B 5.310 GetltemBuffer 16 5.3111 GetltemDLFBuffer 16 5.312 GetltemBufferText 16 5.3113 GetltemKeyText 16 5.314 GetltemName. 16 5.315 GetltemSummary 7 5.316 GetltemSize 7 5.3117 GetltemParsedText 7 5.318 GetltemFieldVatue 7 5.319 GetltemFieldVatueText B 5.3.20 GetltemFields B 5.3.21 GetNameditemFields 7 5.3.22 GetConfigureditemFields 2 5.4 Field interface (IColorltemFields) 9 54.1 GetXML_ 80 5.4.2 GetFieldCount. 80 543 GetPieldindex 80 5.44 GetPieldindexFrom. 81 5.45 GetPieldindex yID 81 5.4.6 GetPieldindexFromB yID 81 5.4.7 GetPieldOffset 82 548 GetPieldSize 82 5.49 GetPieldValue 82 54.10 GetPieldName 83 54.11 GetPieldValueText 83 AReferences ALL Acronyms and terms. 84 eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ vé for Windows OS User Guide Contents ‘igures Figure 3-1 Item Store File Settings. 19 Tables Table 2-1 Minimum system requirements. 9 Table 4-1 Item types 6 Table 4-2 Copying items. 26 Table 4-1 Property command replacements. 43 Table 5-1 OTA log codes/keys - CDMA. na Table 5-2 OTA log codes/keys - CDMA IxEV-DO 1 Table 5-3 OTA log codes/keys - GSM. 72 Table 5-4 OTA log codes/keys - UMTS 72 Table 5-5 OTA log codes/keys - WCDMA. 72 Table 5-6 OTA log codes/keys — Bluetooth. 72 Table 5-7 Getltem Type return values. 73 Table 5-8 Supported field types. 78 Table 5-9 Supported field types. 82 soviastas.e Confidential and Proprietary — Qualoomm Technologies, Ino 7 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION1 Introduction 1.1 Purpose ‘The QXDM Professional™ (QXDM Pro) tool provides. diagnostic cient for dual-mode subscriber station (DMSS), newer user equipment (UE) software, and advanced mobile subscriber station (AMSS) QXDM Pro provides a rapid prototyping platform for new diagnostic clients and diagnostic protocol packets. It provides graphical user interface (GUD that displays data transmitted to and from the DMSS. Nore: The use of DMSS and AMSS in this document refers loosely to user equipment that is connected to QXDM Pro using the Qualcomm Technologies, Inc. (QTI) diagnostic interface 1.2 Conventions Function declarations, function names, type declarations, attributes, and code samples appear ina different font, for example, #include Code variables appear in angle brackets, for example, Commands to be entered appear ina different font, for example, copy a:#.* b: Button and key names appear in bold font, for example, click Save or press Enter Shading indicates content that has been added or changed in this revision of the document. 1.3 Technical assistance For assistance or clarification on information in this document, submit a case to Qualcomm Technologies, Inc. (QT) at https://createpoint gti qualcomm com. Ifyou do not have access to the CDMATech Support website, register for access or send email to support cdmatech@qti.qualcomm com eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. a MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION2 Installation 2.1 Required hardware and software QXDM Pro is designed to be installed and run on workstations running Microsoft Windows Vista, Windows 7, Windows 8, or Windows 10 operating systems. QXDM Pro requires Microsoft Intemet Explorer 6.0 or later and QPST Server v2.7, Build 200 or later (QPST v2.7. 200). Minimum system requirements ‘The mininmum required configuration for QXDM Pro is described in Table 2-1 ‘The extensibility features of QXDM Pro enable it to support unlimited configurations including support for end user-defined applications. A minimum configuration necessarily means that less work can be done simultaneously. Multiple instances of QXDM Pro, other running (including background) processes, and having too many views open at the same time may require more than the minimum system configuration listed below. Table 2-1 Minimum system requirements tem Description CPU {800 MHz Pentium Il lass RAM 168 Hard arive Installation requires 600 MB. Logging requires minimum 20 MB free disk space Note that some of today’s phones are capable of generating log data in excess of 18 MB per minute ‘Operating systems | Windows 10, Windows 8, Windows 7, Windows Vista Port connections _ | One USB or serial I/O port per device (phone, FFA, SURF, or GPS receiver) ‘Sofware ‘GtSWebHit al requirements eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. ° MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Instalation 2.2 Installing QXDM Pro ‘The installer sets up the QXDM Pro execution environment, which includes installing application binaries, data files, and documentation; registering COM automation components and file associations, and configuring QXDM Pro for intial use ‘The QXDM Pro installation consists of two main folders: = QXDM program folder — The path to this folder is set by the user when installing QXDM Pro. The default path offered by the installer is based on the underlying Microsoft operating system program files folder, which is typically C:\Program Files (286)\Qualcomm\ QXDM4 After installation, this folder wall contain subfolders containing the QXDM Pro binaries, and QXDM Pro documentation Under this will be several subfolders containing QXDM Pro automation script samples, implementation files for all QXDM Pro HTML-tased displays, and user-submitted QXDM Pro extensions, = QXDM data folder — The base path to this folder is set by the underlying Microsoft operating system and represents the documents folder shared by all users of the host PC Typically, the Microsoft Windows shared documents folder is located at C'\ProgramData\Qualcomm\ QXDM\ ‘The resulting complete path represents the QXDM data folder. Under this will be several subfolders containing the QXDM Pro database, user defined Hash file, and the reference QT vendor database. Italso contains a folder named C:\ProgramData\ QUALCOMM\QXDM\ConfighQualcomm DMC Library\Primary, which includes the default DMC file ‘The folder located in C:\users\usemame\AppData\Local\QXDM contains DMC files, user database (the default path can be changed), and other supporting files. The temporary QXDM Pro item store format files are located at C:\Users\usemame\AppData\Local\Temp\ QXDMUSF. The installer createsa QXDM Pro folder in the Windows Start Programs menu that can be run by selecting Start > All Programs > QXDM. The installed application binaries and user guides are accessible from this location, QLMS activation A one-time online activation is required before QXDM Pro can be run using Qualcomm license ‘management system (QLMS). Follow the instructions provided by QT! to activate QXDM Pro. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 0 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Instalation 2.3 Physical connectivity QXDM Pro connects to a phone or SURF through the QPST server using serial or USB cable to @ COM port on your PC SURFS, FFAS QPST Clients g XDM| 2.4 QXDM Pro documentation QUDM supporting documents are available at https //createpoint gti qualcomm com, = Qualcomm ISF Processing Interface — Qualcormma ISF Processing Interfaces (80-V5627-1) provides documentation for the postprocessing and analysis automation interface that supports user database definitions (with preference towards the latter as it provides a richer interface). This interface does not differ in any substantial way from the real-time automation interface QXDM Pro utilizes to implement the existing QXDM Pro displays. QXDM_ Automation Application Notes (80-P2559-1), a Release Notes — Revision changes for each version of QXDM Pro are detailed in the ReleaseNotes file as part of the installation package. 2.5 Item store format (.isf) files While running, QXDM Pro generates a temporary log file called the Item Store, which ensures that data is not lost in the event of unexpected program termination Under normal circumstances, this file is deleted upon termination. The Item Store is created in the QXDM Pro ISF folder (typically Located at C:\Users\user\AppDatalL ocal\Temp\QXDMUISF). ‘The Item Store contains all traffic that occurs between QXDM Pro and the target (or targetsif QXDM Pro sequentially connects to more than one target in a given session) or since the last time the Item Store was cleared, e g., via the Save Item (Ctrl + 1) menu command. This provides an accurate representation of the state of the application at any given time for analysis and debugging e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. rn MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Instalation Always-On logging QUDM Pro is always generating an ISF log file. Log files can be processed by QXDM Pro at a later time for post processing analysis and replay. Always-On logging behavior can be customized from the Item Store Settings command, ‘The Application Statistics viewis the place to go for monitoring the status of logging Recovering the Item Store If for some reason QXDM Pro is terminated abnormally, the session can be recovered. Section 3.1 descibes howto load an ISF file. In the event of abnormal termination, it may be possible to recover and repair the lost session. The temporary ISF is located in the QXDM Pro ISF folder. Saving the Item Store By default, the ISF is deleted upon QXDM Pro termination To savea session for later analysis or viewing, select Enable Query For ISF Save (see Figure 3-1). e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION3 Menu overview QUDM Pro uses a multiple document interface to support any number of views simultaneously. 3.1 File menu Annotate » ‘Manage Configuration (DMC)... Ctrl+M. Load Configuration. Ci+0 ‘Seve Configuration Culss Load Default Configuration Open. cule New Items, Alte Save ems. cust Replay tems. CHisR hem Store Settings. Recent Data Files > Recent Configuration > Exit 3.1.1 Annotation User can insert annotation in the item view at real-time while gathering log. The added annotation will be saved as part of the isf fle. This fimctionality is only available during log collection phase, and will not work in an already saved isf file eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview Send Key Is Pressed Aro Any Key Is Pressed ane Call Origination Ane2 Call Termination Alte Failed Call Aled Dropped Call Anes: No Speech Anes Speech Pause Alte? High Interference Ales Frequent Hand-Off Zone Alt+9 Hand-Oft Fall Pilot Pollution Max Access Probe Paging Indication Terrain: Dense Uroan Terrain: Rural Terrain: Tunnel/Bridge Terrain: Wooded Sample 3.1.2 Manage Configuration ‘Manage configuration with diagnostic monitor configuration (DMC) e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 14 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Use DMC files to set the data packets to be lo Menu oveview sd, Setting the comrect DMC ensures that comect packets are collected. DMCs canalso specify which views need opening for further analysis, ‘The Manage Configuration window shows QT! and user DMCs. Select the desired DMCs and click OK. The DMC selection sends the request for the packets, as shown in the Item View window. Click Import DMC File(s) to add additional DMCs, or click Show in Explorer to manage DMCs within the file explorer. Click Save As DMC to save the selected DMCs asa single DMC, or click Save As TXT to save the packets as text {Th manage Conguation OM) hose Coin (4 Fle for Your Seon Tlduslcomm O6C ray © Chonmary etauttame v Dseconsan ¥ Casio Dandiosascame Dadiobencanesne Di audiodericetedme Dl avdiesteammudme CD avaiesteamticme >) [root oneri Showin Blo. To start recetving ‘appropiate packets, check the DMC(s) you re Interested In nd dick OK. » Con You can then see the CO petsutame resulting packets inthe » Cas "tem View and save avsstocstontaggingame them toan 1SF using the ¥ Cliios bee "Fle > Save lems” mana Ccnenesagenlisne option. 1 ewnessagealidme CF eusaversageniiame e ona rats coos ten Tas) [Doing Matores Packets a [i Diag Recussts ID big Responses sow |C. Event Reports C1 Yoo! Generates il Log Packets Dae tg Pacts OTA) aivercot Di rdessage Paces Gor’ Dstrngs Oe ID subsystem Dispatch Requests Dseeury ID subsystem Dispatch Responses Gusts ID subsystem Dispatch Requests une ID subsystem immediate Dispatch Responses weoma ID subsystem\2 Delayed Dispaten Responses Gesu e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ vé for Windows OS User Guide Menu overview 3.1.3 Load Configuration Previously saved configurations can be loaded using the Load Configuration command. Configurations such as selected views and registrations are restored from QXDM Pro configuration files ( dmc extension), [BOE me cae toe > o Gane ns Zrccovesnst Sa Freon ans gun sin Broan Semen Foon ieee Fam fammeiann Foon Mumsnet Sime crams ‘Enmanccecc Senn Bieri Paces 3.1.4 Save Sonfiguration Configurations remember selected view registrations and settings and can be saved to QXDM Pro configuration files ( dmc extension) for later loading. SG rae Gea) nem + Doors» OC pute Newt ea en sere Dasmeied ate — Brome cow Bees Ube Bom snus conte mene sc Bom en Srewe Sart [QE ie oi i Hite Ga) aes) e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 1° MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.1.5 Load Default Configuration Click “Yes” will restore default dmc and views Bi Reset Detauit om x e Reset To Default Dmc Configurations? ver No 3.1.6 Open Select a QXDM supported file for post processing and modification 3.1.7 New Items New Items creates a new temporary isf file. Thisis useful if you have been reviewing an existing file store (by loading or replaying it) and now want to connect toa live target without appending to the current file. This option can also be used to start a new sf file in advance of commencing a test. 3.1.8 Save Items Save Items behaves exactly the same as New Items except that there is no check to see if Enable Query For ISF Save is checked. 3.1.9 Replay Items A previously saved isf file can be loaded for replaying using this command. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 7 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ vé for Windows OS User Guide Menu oveview Reply Oetsdal Hh) ots Nexium Geo (Gm) ]Conpact tay Aybar Sped (RealTime =] Curent ten a = Maximum Gap - Set the maximum amount of time in milliseconds to wait before playing the next item. Ifthe actual gap exceeds the configured value, the configured value will be used as the amount of time to wait until playing the next item. «Playback Speed — Set the speed at which items are played. Note: Using the No Wait option can impact system performance when views are open that process each and every item. = Compact Layout - Information about an item is displayed ast is processed unless Compact Layout is checked. 1 Step — Replay just one item = Play/Pause — Replay based on the selected settings. To stop replaying, click Pause, e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.1.10 Item Store Settings ‘The Item Store Settings dialog allows the user to control ISF logging behavior Fi settings 7 x Sem sore Fie | cererlopvons Enadle que saving [fre] NV Browser a) © Posing and pes | 199Fle Bredory | [Tze © to Zoning O mF O Bip and Delete SF @ www Gos @ General ‘Automatic Post-Processing @ Standard Mode C1 Enable Query Far Fle Save © Advanced mode Maximum Log Fie Size Unlimited z Maximum Log Fe Duration nla z Automatic w asrnum Archive Count Unie = Log View Settings Save Log View contents to fle after dosing. Log FilePath [C:\Usersgfong\ppbata\Loce Tam Figure 3-1 Item Store File Settings 3.1.10.1 Item Store File ‘The default behavior is for QXDM Pro to prompt for a log file name on user-initiated log file saves (¢.g., File—rSave Items). e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 1° MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview = Enable Quick-Saving — When Enable ISF Quick-Savingis checked, the log file is saved using the Base ISF Name at the ISF Directory location, without prompting the user fora filename Note: This applies only to scenarios where the user has initiated the save, ie., by selecting the Save Items menu command. In the other scenarios, where an ISF must be saved due to a parallel operation (New Items, Load Items, and exiting QXDM), the user may stil be prompted for a filename (dependent on the mode). In all scenarios, an automatically generated name will appear in the prompt dialog itself Base File Name ~ Use Base ISF Name to describe the unique portion of the ISF filename that wall be used when in Advanced Mode. Using the tase ISF name, QXDM Pro wall format the name as follows. ¥M-DD-HH-MM. ist «Log File Directory — Use ISF Directory to describe where to save ISF files The default is located in the Microsoft Windows shared documents folder for all users typically at C:\Documents and Settings\All Users\Documents\Qualcomm\QXDMAISF = Automatic Post-Processing - Automatic post processing of log files is supported by providing a command and optional arguments that QXDM Pro will run each time a logis saved. The log is passed to the specified command by QXDM Fro. © Command — Enter the command including the fully qualified path that QXDM Pro is to run, ¢g, CWINDOWS\System32\CScnpt. exe © Arguments — Enter any required arguments for the command, eg, C:\TestScripts\ISF AnalyzeLogl 234 js. The format requirements are the same as ifrun froma command window, i, ifthe argument contains spaces, it should be enclosed in quotes. Mode Options ‘The default logging mode is for QXDM Pro to delete the temporary log file upon program termination. = Standard Mode - Selecting Standard Mode results in the default behavior described above, Enable Query For File Save - When this option is checked in Standard Mode, the user is prompted to save the temporary Item Store upon creating a new Item Store (New Items), loading an Item Store (Load Items), or before exiting = Advanced Mode — Selecting this option causes QXDM Pro to apply the advanced options described below. 2 Maximum Log File Size — Use Maximum ISF Size to set the maximum file size the current temporary ISF can reach before it is closed and a new temporary ISF is used. 2 Maximum Log File Duration — Use Maximum ISF Duration to control the maximum, file duration (time between first item's generic timestamp and last item's generic timestamp) that can elapse before the current temporary ISF is closed and a new ISF is used. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview = Automatic File Saving When Limits Reached — This checkbox controls whether an ISF that has exceeded specified limits is automatically saved. Ifit is not checked, the temporary ISF is deleted when limits are reached. Maximum Archive Count — Use Maximum Archive Count to control the mazimum umber of ISF files that will be saved. When this value is exceeded, the oldest ISF saved by the current QXDM Pro process is deleted Log View Settings © Save Log View content to file after closing — If selected, all content in the item views will be saved Log File Path — File path for saving log view content 3.1.10.2 NV Browser = No-Sleep Probe — Diag command to force phone to be out of sleep mode. This operation is, for Mac and Limux only. 3.1.10.3 Parsing and DBs Protocol Categories/Revisions = CDMA ~ Thisis used to control the protocol revision utilized by QXDM when parsing CDMA over-the-air (OTA) messages. Item Store files created by QXDM version 03.08.99 or later utilize the most recent CDMA protocol revision reported by the target. For these files, (and real-time interaction), the Automatic choice is the best selection, For files created by (QUDM versions prior to 03:08 99 the option should be set ta the appropriate protacol revision Utilizing the Automatic choice when viewing an ISF created by QXDM versions prior ta 03.08.99 is equivalent to choosing [06] - 18-2000 Rev 0 = WCDMA ~ This is used to control the protocol revision utilized by QXDM when parsing WCDMA OTA messages. Item Store files created by QXDM version 03.09.15 or later utilize the WCDMA protocol revision reported by the target. For these files (and real-time interaction), the Automatic choice is the best selection For files created by QXDM versions rior to 03.09.15, the option should be set to the appropriate protacal revision Utilizing the Automatic choice when viewing an ISF created by QXDM versions prior ta 03.09.15is equivalent to choosing 06/04 V5.9.0 «HSDPA ~ This setting allows control of the HSDPA UE category used when the QXDM HSDPA displays need to map CQI indices to bit sizes. This value should match the UE category of the connected target. = Vendor Database Path A vendor-specific database is used when parsing items specific to a particular handset vendor. A vendor-specific database can also contain mobile model names. = QShrink3 User Hash Location Location of QShrink3 database = QShrink Server Path e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 2 Server location of QShrinlet database. 3.1.10.4 TCP IP = Accept Incoming TCP Device Connections Only used by Mac and Linux. Once configured, user can select the connection in “Option > Communication” list a User Port Number (Default: 2500) 2 Host machine network port number 3.1.10.5 QPST = QPST Port Trace will be enabled for debug tool issue. Only applicable for Windows 3.1.10.6 General = Font For Item Lists: Change the font of the item list view = Default Plot Legend Area (%): Set the default size of legend window for all graphic views = Plot Background Color: Set the default background color for all graphic views 3.1.11 Recent Data File Display the history of past loaded item store files 3.1.12 Recent Configuration Display the history of past loaded configuration files 3.1.13 Exit Click Exit to end the QXDM Pro session. 3.2 iew menu This section discusses options available through the View menu selection e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview G. QxOM Profesionl- Ont ie [Wi] pions Tonle Window Help USE connor DO corns nse fires +k seats ee ors cae ums Lower ayer epee > TEN Acquetin PRCH ening Mesurement us Eres » TEN Connected Node RSP RSQ SINR Dipay ‘TDscoMA Maclay >) TEN DL Troughput nd LER LTE NL Sering Cl Messrerent Diy Vette Video LTE Views under view menu are created based on diagnostic packet definition Tables, charts, and values are displayed based on diagnostic packet received from UE. For descriptions and details of diagnostics packets, please reference to technology interface control dacuments (ICD) This section only coversa few commonly used views Item & Filter Views An item viewisa scrolling view that contains zero or more items that are derived from the contents of the current isflog file. This includes the Item View, Filtered Views, the Messages View, the Log View, and the Command Output display 3.2.1 Item View ‘The Item Views a special item list view that shows all items generated duringa QXDM Pro session. When QXDM Pro is run, a temporary ISF is created in the QXDM Pro ISF folder (typically located at C:\Userswuser\AppData\Local\ Temp\QXDMAISF). The Item View shows the contents of this temporary ISF log file and can be displayed from the View bar or by using the Fil accelerator key. An item list view has three adjustable panes. The top pane is a scrolling list where a summary of ach item in the viewis displayed. The bottom left pane is used to display (in a hexadecimal dump) the raw data of the item currently selected in the scrolling list. The bottom right pane is used to display the parsed fields or (when available) the parsed text of the currently selected item inthe scrolling list 3.2.2 Filtered View A Filtered View represents a subset of the contents of the current isf file and therefore the Item View. This subset is configured by item type andlor item key. Unlimited filtered views may be created by using the accelerator key F12 or selecting Filtered View from the View Bar. Filtered views can also be created by interacting with an existing item list based display through the Refilter Items, Match Items, and Process Items menu commands. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview 3.2.2.1 Scrolling list pane All item list-based QXDM Pro displays contain the scrolling list pane. This includes the Item View and Filtered Views. This pane displays each item in the view, one per line in the list Right-Click options Right-clicking within the scrolling list pane brings up the context-sensitive menu. [000M Prstesionet nnn File View Options Toole Window Hela BOF EBB D @ comers: mt ore “Time Stamp Name Summary Payload Sootrar tem ‘The context-sensitive menu is used to configure view registration, alter appearance, copy t locate items, clear the view, and view rawitem content e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 24 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Configuration in Filter View Menu oveview Selecting this menu option allows control of which items are added to the view in question. ‘The left side of the configuration dialog is used to identify what item types the filtered view will accept. The right side of the dialog is used to filter item type content based on item key and to register with the phone for items of interest. ‘This configuration dialogis only supported by Filtered Views Diag evens Br Legectae LogPeces (OTA) Sater apa Regus Stketen Dpto Pato Pcs Dos [P dmeanaus acer ate me Pans me (7 yee baa Seice pwn Pane Bpetng F Meden tein Bow Bors Es Bos tse Devs Boa Dom Deowcomaev00 Panrsissaseos Items are grouped into types, as shown in Table 4-1. Item types allow QXDM Pro to classify incoming data from multiple sources: synchronous and asynchronous traffic between QXDM Pro anda target, GPS receiver data, and intemally generated strings e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview Table 4-1 Item types Htemtype Source Diag Malformed Packets Phone Diag Requests (@XDM, User Diag Responses Phone Event Reports Phone GPS Reports GPS Receiver Log Packets Phone Log Packets (OTA) Phone Message Packets Phone ‘Stings (XDM, User ‘Subsystem Dispatch Requests (QXDM, User ‘Subsystem Dispatch Responses Phone Copying All or part of a filtered view output can be copied to a new ISF, a text file, orto the clipboard. ‘The action is controlled by using any of the methods given in Table 4-2 Table 4-2 Copying items tem Description Copy tems Copy selected temeto an Rem Store Format (ist fle Copy Allitems Copy Allitemsto an item Store Format (ist fle Copy Text (alt+ C) Copy selected test to the clipboard Copy Head Line Only (Ctil+ C)_| Copy head line Fom an fem Export Test (alt F) Export selected items astenttoa fle Export All Text (Alt+ A) Export allitems astex to a fle Select All (Ctrl + A) Select allitems ‘Text output from loaded dynamic parsers, built-in OTA parsers, and extended database descriptions will also be copied if the menu item Options —»Export Parsed Text is selected. Text output is subject to change. Use postprocessing tools, eg , QCAT, to generate consistent text output for more reliable text processing results All of the above operations, excluding copying text to the clipboard, result in the display of progress dialog. This dialog displays the progress of the operation, statistics related to the operation, and any errors encountered in the process of the operation (such as errors reading an. item from the current ISF or writing an item out to the new ISF). Additionally, the progress dialog allows for cancellation of the operation before it has completed. In this case, the partial results are written out to the new ISF or text file Searching Each line in an item list views the text representation of the properties of a particular item. This text can be searched to find an item that meets given search criteria Additionally, each item in an e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview item list viewis associated with an index. This index can be used to jump to an item For items with type Message Packets, additional information present in the content ofthe item can be used to locate the point in the target source code where the item originated Find Selecting this menu option (or using the Ctrl + F keyboard shortcut) allows searching for text ‘within the item list output Both the type of item and the item properties to be searched can be configured Bernd 7 x seareh For |] options Diredtion RegexEngine [tre FutlPorsed Tet © Up © tone [lense Senate Search ® Doun Ore Ci mvertes search Ci start From selection ‘Types To Search 7 dieg Molformed Packets oa Requests Iv 029 Responses M7 event Reports Iv Ps Reports FF toa Padats Log Pockets (OTA) v1 massage rackets M strings | Subytam Dispatch Requests [Subsystem Dispatch Responses |e Uninonns Find anos In addition to search direction, the following options are supported: Include Full Parsed Text (When Available) - When this is selected, the search engine will, also search the full parsed text that appears in the lower right-hand pane of the view. = RegEx Engine — The parser will accept regular expressions when JScript or Per! options are selected. Although support for JScript is included wath the Windows operating system, Perl requires a separate installation Dacumentation on regular expression syntax for these scripting languages is beyond the scope of this document, = Case Sensitive Search - By default, the search is case-insensitive e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. Ea MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 1 Inverted Search — When thisis selected, the search engine will search for any pattem not ‘matching the search criteria from the set of item types and item properties = Start From Last Selection —By default, a new search is from the beginning of the file Checlang Start from Last Selection ovemides this behavior. Other search options include = Find Next - Search for the next Find match. This command can also be executed by pressing Curl+N = Goto Item — Go to an item by specifying its index using the Goto Item command. When successful, QXDM Pro will highlight the item at the index specified. This command can be executed by pressing Ctrl + G = View Source — View the target source file associated with a selected item This command canalso be executed by pressing Alt+ V. Use Options — Settings (see Section 3.3.2) to specify the search path used by QXDM Pro. = Auto-Seroll - When new items arrive and are added to an item list view, QXDM Pro can. automatically scroll to the end of the item list in order to display the new items, The Auto- Scroll menu option allows for enablement or disablement of this behavior. Control automatic scrolling by pressing Alt + S or by manually scrolling using the scroll bar, arrows, or Page Up and Page Down keys Clear Items Clear Items allows all items to be flushed from an item list view. Items may also be cleared by pressing Shift + Delete Items can be cleared from any scrolling view except the Logging View. Take care ‘when clearing the Item View because doing so results in the current ISF being emptied and the connection being reset. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. a MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview Match Items ‘Match Items allows for creation of new filtered view based on a matched pattern froma selected set of items in an existing item list view. Configuring this process is nearly the same as configuringa find operation. Ba Fina > x searenror: [] pons Drectin RegEx Engine (Cl incite Full PorsedTet © Up © tone Clase senaave search @ own Ores Oi tiverted search Ci Start From Selection ‘Types To Search Ccontentsto Search 1 ova matformes rackets Dieg Requests 1 oven Responses Type Key swans Reports ae Iv) Ps Reports Timestamp Lo Packt summery 7 ton Packets ora) Il messane Factets MF stings Iv Suboystem pspater Requests [Subsystem Dispetch Responses i vninowns Payload ardvore Timstomp Subserpton Processor Fd canoe ‘The only difference is that the direction and selection options are not available. Instead, the operation starts from the first selected item in the current item list view and ends with the last selected item e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Process Items Menu oveview 1 Refilter Items ~ Create a new filtered view froma selected group of items in an existing ‘view based on item type and/or item key. Configuring the refilter operation is no different than configuring a Filtered View. Diag ars aca Dag Reqese DagRetonses fre pote og Paces (OTs sage aches Snge sister Dispatch Requests Log Packers [fost tempera nya Obeles [tonto] x6 Power Conte (Otele) [Fonte ru! nk Fame ype (Obelt) [oat] tee nk Fe pe [fost cer Conn cage [oats] eee Chane! Tie Meage [2 oat yn heart Ti eaege (2 eawon [feat] nun Channa Werage [feat ngefomatin Otis 1 featoc ene Pace seoche bfemstion | to] EaKinernnon bela) Ite Motos sate ItA0tFSexeerntetion Obl) Ioaoio ener Samr(Obelee) Iasi voceercroriiee Tot Arig Vice Channel [aon acces Peselrannton [oa0is| Ter Wenlecemmans [ta0ie Spare Pane Cone [oaoi7] gene change [ati] Geren Te tfamsin [a0ia| Geen! Teh cH ofan [0c desing Fru Chnnel Tei0] Asieg Revere Chane [ati] ring nat ny lean) sin emeremy So = Raw Item — This option displays the raw item contents in hexadecimal form for the currently selected item A context mens can also be used to control the layout by clicking the right ‘mouse button over the Raw Item Contents view. 0 BO 09 72 7 021 00 00 e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview Syne Near Item — Sync Near Item tries to find the item with the given index in all item lists In each lis, ifthe item with the given index is found, itis selected. If the item wath the given index is not found, the item with the index closest to the specified index is selected. It should be noted that item position correlates to generic timestamp, i.e, the item at index N asa generic timestamp that is earlier than the item at index N + 1, etc. In general, there is no correlation between item position and item-specific timestamps as they originate extemal to QXDM Pro. em View Key Tye Time Stamp Name Summary Payload TSSUCI/OO2 OTA LOC 198/006 Nea USS DCCH/ULL Radio Bearer Ls 1OU0IO01T00. Gi tered viewarc) Time Stamp TC Tao e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. a MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview Syne To Item — Sync all filtered views to the same selected item, if found. Sync To Item tries to find the item wath the given index in all item lists. In each list, ifthe item with the given index is found, it is selected. Ifthe item with the given index is not found, no change is made Time Stamp ‘Summary ro ere DCN TALS McC radio Bearer LOSI LG. rteed entteh) Key Type __TineStamp Peres = Bookmark Item — Mark selected items and adds them to the bookmark list view, To add a boolmari: a Click FileOpen and locate the ISF. Click ViewCommon—ltem View (FJ). Select an item to bookmarc and press ALT+B . Alternatively, right-click the item and select Bookmark Item. To navigate using bookmarks 4d. Click File-+Open and select an ISF that has bookmarks Click View Common —Item View FID) £ Press ALT+U to navigate up the bookmark list or ALT+D to navigate down the list Nove: Navigation commands have no effect if the Location of a bookmark is already being viewed and there are no additional bookmarks. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Menu oveview 3.2.2.2 Raw Item pane ‘The Item Viewand Filtered View contain the Raw Item pane, which displays the raw item, contents in hexadecimal form for the item currently selected in the Scrolling List pane 3.2.2.3 Parsed Item pane ‘The Item Viewand Filtered Views contain the Parsed Item pane. This pane displays the parsed. fields or, when available, the parsed text of the currently selected item in the scrolling list pane. Not al items have associated parsers to display parsed text in the parsed item pane. Item data is parsed using definitions in the QNDM Pro database, SILK, and ASN.1 for OTA log items, or (see Section 3 1). Menu options Right-clicking within the Parsed Item pane opens the context-sensitive menu. ere OTALOG, 1300/01/06 00. UL DCCWULL. Radic Bearer 11000400400. 20 00 4c 09 Co BO 00 97 01 00 00 02 08 50 02 F2 01 2c 01 00 0g 98 33.00 48 06 OF p.a.,, 40 5A 02 25 02 20 GE 0C ED CE copy cuec | ges. aia 2c AE 40 €C 6D ED A¢ £2 FO 10 | 1 2GimixEs. ]2#-28 c2 00 90 on 20 o.co od SE a e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.2.3 NV Browser NV items stored in the nonvolatile memory of the connected target can be viewed and modified using the NV Browser. Note: cox, Etec Seal Number = (co Heston Sot Numer Cheam Seo ea Where eer Sens {ao Stston Clerk ‘on (co Sletcraetnce doteeinder (ce Mobic Od Resion Ne moeare, (cos Nabie rere aon irser rab ime (co) Mabie oe rated {co ormguatecheceum ‘en esum (co) Desa iacg Mee rence prsmoue (con) Cohan Serna Spe ‘pe se a Salon Pere Senn Sem 08) tia. cos Bso octow fina ock me ve ene) be) PSN Probe Cott 5a esup_) [_tesire | (_ ote feet) |_ ‘The Category Filter can be used to view just NV items belonging toa single category. To read an NV item, select the item to display the names of all the fields for that item and click the Read button to read the values from the phone. To write an NV item, select the item to display the names of all the item fields. To change the values, click the value in the Input column, After modifying the values, click the Write button to write the updated values back to the phone. NV items can be sorted by clicking the column header Columns can be reordered by holding down the left mouse over column header and dragging it to a newlocation. The left-most cohumn can be searched by typing the name or number of interest Search typing is case-sensitive. The status of the NV read and wnite is given in the bottom left portion of the display. If clicking Read or Write yields DIAG Error Received or NV Status Error Received, then the target was not able to handle the request. = Offline - Use the Offline button to send the Mode Change Request Offline command to the phone before writing NV items that have mode-specific requirements. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 34 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview a Reset —Use the Reset button to send the Mode Change Request Reset command to the phone. This command when sent to a phone in Offline mode will result in the phone being recycled. a Read — Use the Read button to read the selected NV item from the NV memory of the comnected target | Write — Use the Write button to write the selected NV item to the NV memory of the comnected target 3.3 Options menu Communications Settings, Dip Switches. Reset Target Set Target Offline Refresh Target, Reset Application Settings Separate Views for Multi-SIM Load QShvink4.0 Database. Parsing Options » 3.3.1 Communications ‘The Communications dialog, shown in the figure below, lists all ports in the system and the port properties, and allows users to choose the COM ports used by QXDM Pro for connection purposes == Go e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview A table lists all ports in the system and their properties, including Port Type, Port, State, Label, Phone, and Data Rate Ifa portis checked and the Port Type is diagnostic, the port was added in the QPST Configuration tool and is monitored by the QPST Port Server. Ifa port is unchecked, it is not under the monitor of the QPST Port Server and is not in the QPST Configuration tool By clicking the checkbox and changing the status between checked and unchecked, the port can be added to or removed from the QPST Port Server monitor (2 to 3 secis needed to update new port information to the display) Double-click the blue globe in the Windows Task Bar, shown below, to configure the ports that the QPST port server is monitoring ‘The QPST Configuration utility is shown below. G WST Configuration egal] Ble Sever StartGhemte Window Help Hcive Pres] Pots [deve Gls [1P Server] sate Label Emme |[ bene | [_ Benove [Bcc en Por [oPhones DPorts ——2Clients Server Running, Store log mask on device ‘When enabled, a Diagin file will be generated in device to store the log masks used in QUDM session. This file is generally used to re-enable log masks when reset without connecting to QXDM. 3.3.2 Settings Please refer to 3.1.10 - Item Store Settings 3.3.3 Dip Switch Send the Dip Switch diagnostic command to device e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.3.4 Reset Target Select the Reset Target option to send the mode change request reset command to the phone ‘This command, when sent to a phone in offfine mode, results in the phone being recycled. 3.3.5 Set Target Offl Send mode offline diagnostic command to device 3.3.6 Refresh Target Re-establish QMDM session to device, as if new connection was made to device 3.3.7 Reset Application Settings To reset QXDM tool setting to factory default Separate Views for Multi-SIMEnabling this option triggers applicable views to be duplicated per SIMas new packets amive. Disabling this option keeps all SIM information within a single view. 3.3.8 Load QShrink4 database In the case where a specific QShrink# database is to be used. User can manually load the (QShrinké database files into QXDM Pro. It supports two file types: = Uncompressed file type * qsr4 = Compressed file type *.qdb <¢° 6 oo) Exel Teelites lt 1 Fosotes Documents library a pup acces. oeaons Boownoad: — fe) cine = Daten|* BE iecert Paces, fb National Instruments wwe Ti OneNote Netooke 0 ire Bi Qustorm wud Eidooment, Bi Veus stadia 2008 BES Bi Vins sudo 2003 Bae le - FS writes > Flename - QUE extase Meee) eoviest2se Confidential and Propietay—Qualerm Technologie, ne or MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview If QXDM Pro is connecting to the device and the correct database files have been loaded, the QUDM Pro status bar will change the QShrink 4.0 database downloading status from “SR4° DB Download Error” to “QSR4: Download Success.” The QShrink4 debug messages can be correctly decoded after loading The corresponding QShrinke4.0 database files are copied to the IMessageHash folder I an onesene sane Coeteweetaes tmnt Oe 3.3.9 Parsing option Export Parsed Text (QCAT Format Parsing DLLs 3.3.9.1 Export Parsed Text If enabled, when an item is copied, fully path, including header info will be copied 3.3.9.2 QCAT Format If enabled, the compatible item content wall be displayed in QCAT format 3.3.9.3 Parsing DLLs When selected, compatible item content will be displayed corresponding DLL format Location of the parsing DLL is in c\ProgramData\Qualcomm\QXDM Parsers 3.4 Tools menu CFGFile Generator FS Database Editor PPP Extractor 3.4.1 CFG File Generator Function is used for generating an on-device log file e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies. Ine. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview Soloc Fier View {Fitered view:[0] E hose tar Types) Diag Matformed Packets (ig Requests Diag Responses [m] Event Reports Log Packets {BH Log Packets (OTA) Im Message Packers strings C Subsystem Dispatch Requests Subsystem Dispatch Responses Ci subsystemv2 Dispatch Requests Subsystem immediate Dispateh Responses 1 Subsystem2 Delayed Dispatch Responses [1 Delayed subsytem Responses Only ‘Accept Unknovms Choose Ram Type(s) Louch in Fite View..| Shove Dafoulcfg $0 Logging: 5 ok cose 3.4.1.1 Delayed Subsystem Responses Only When selected, only the delayed subsystem response will be shown 3.4.1.2 SD Logging: Save and load cfg file to a specific directory 3.4.1.3 Accept Unknowns Device has logs that is not yet defined in QXDM database 3.4.2 Database Editor Launch DiagDbE ditor application. 3.4.3 PPP Extractor Launch PPP extractor application. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. = MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.5 Window menu Clear alt Cascade Minimize All Restore All Tile Horizontal Close Close All Auto-Scroll All Ctl+AltsS Previous Window Next Window 3.5.1 Clear All Data from applicable windows are cleared 3.5.2 Cascade Windows that are opened are rearranged in a cascading order 3.5.3 Minimize All All open windows are minimized 3.5.4 Restore All All minimized windows are restored to their open settings 3.5.5 Tile Horizontal Windows that are opened are rearranged in a horizontal fashion 3.5.6 Close ‘The windowin focus are clased 3.5.7 Close All All windows are closed. 3.5.8 Auto Scroll All Auto scroll all item, filtered, log, and message views e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Menu oveview 3.5.9 Previous Window Focusis set to the previous logical window 3.5.10 Next Window Focusis setto the next logical window 3.6 Help menu Licensing , About Targets ‘About QXDM Professional 3.6.1 Licensing Licensing allows visibility of the status of the QLMS license. Ifthe QXDM Pro QLMS license must be temporarily released on the current computer, select Deactivate. Nore: QLMS license deactivation requires an Intemet connection, Attempting to deactivate the LMS ficense without an intemet connection wall remove the license from the current computer but will, still remain in the QLMS system. In this case, the only way to reclaim the license for use on another computer is to contact QLMS support and have the license manually removed from the QLMS system 3.6.2 About QXDM Professional Displays the version of QXDM tool e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. a MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Icons & Indicators 4 Icons & Indicators BOY BABES O® om: ~ fuck Search: = © Communication — See section 3.3.1 © open—see section 3.16 © Repty 1sF - See section 31.9 = ¥ Filtered View — See section 3.2.2 «© item view- See secion 322321 «© nw Browser See section 323 «save 157 See section 318 ‘New Item — See section 3.1.7 » D create CFG Fite— See section 34.1 34.1 = © Reset to Default DMC — See section 31.5 + ® device Build tnto Display mobile build information. Info can also be found in View->Common-dDevice Information 4.1 Command ‘The Command bar provides access to the legacy QXDM Pro command interface. Command: mode offine-d 7 Command interface Although many legacy DOS DM script commands are supported through the QXDM Pro command interface. The recommended approach for automated testings to use the automation interface (see Chapter 5), e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Icons & Indicators Script commands can be typed in to the Command edit control. The Command Output display and the Item View display script output. Additionally, any Filtered View configured for the item type “Strings” and the item key “Automation” displays scnpt output Script Help for command interface ‘The Script Help page documents all supported commands. It is available in the View combo-box from the View bar. This viewalso provides documentation for the legacy script commands that are part of the original DOS DM scripting interface nore: QXDM Pro property definitions are not sufficient to describe many diagnostic packets and have been migrated to the QXDM Pro database. User-defined property definitions wall also need to be migrated to user database definitions Nove: Table 4-I lists the replacements that should be used instead of the obsolete property interface commands. Table 4-1 Property command replacements @xoms ‘axoma RequesiiienFile RequestNameditem RequestNameditemFile 4.1.1 Command functions ‘The Script Help page documents all supported command prompt functions. It is available in the View combo box from the View Bar. This view also provides documentation for the legacy script commands that are part of the original DOS DM scripting interface. Some script commands direct packets to the test phone, while others affect only QXDM Pro operations. Command output is displayed in the Command Output window and can also be viewed from the Item View and any Filtered View that has registered interest in automation string items Several functions are provided to support waiting for, requesting, and parsing of any item that is described in the QXDM Pro database. Additional support is provided in the Item Tester application that provides formatting examples using these commands for all items described in the database. The Item Tester is accessible from the QXDM Pro Tools menu. 4.1.4.4 CWait This halts scripting fora specified amount of time Parameter Description Time Time in centisecondsto wait Usage example Wait 500 Halt scripting for 5 sec sovi2s25.¢ Confidential and Proprietary ~ Qualcomm Technologies. Ine 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Icons & Indicators 4.1.1.2 Echo Adds text string to the DM Item Store Parameter Description Text "Adds the provided sting to the DM Hem Store with the Automation type, tre sting will appear ina is-based viewregistered for this type (including the Command Output view) Usage example Echo “Test completed” 4.1.1.3 Mode ‘This requests that the target performa mode change. Parameter Description Mode Mode can be one ofthe following sting values: + FTM—Change to Factory Test mode + LPM—Change to LowP over mode + Offine-A— Change to Offine Analog mode * Offine-D — Change to Offine Digital mode + Online — Change to Ontine Digital mode + Reset —Reset the target (may require Phone Offine mode) Usage example ‘Mode Reset — Requests the target reset 4.1.1.4 Pause This halts processing of a legacy script (scr) processing The Space Bar must be pressed in the Command edit box to continue processing Usage example Pause e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. “6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Icons & Indicators 4.1.4.5 Requestitem Requestltem allows the scheduling of a request to be sent to the phone, The request itselfis built according to a description entered into the QXDM Pro database or the user database diag entity table, Requestltem waits for a response and, ifreceived, parses it according to the default description in the QXDM Pro database or the user database (if'a description exists) Parameter Description Name ‘Name of diag entity to request (entity must be either a diag request or subsystem dispatch request) Fields List of space separated fields usedto buld he request Usage example RequestItem “Version Number Request” RequestItem “Extensible Parameter PR rieval Request” 1 1 100 4.1.1.6 RequestNVitemRead RequestNV ItemR ead allows for one NV read request to be scheduled to be sent to the phone. The request itself is built according to a description entered into the QXDM Pro database or the user database diag entity table. RequestNVItemRead waits for the response and, ifreceived, parses it according to the description in the QXDM Pro database or the user database diag entity tables. Parameter Description NvitemName | Name ofthe NV fem ently fo read Fields Field values usedto buld the request Usage example RequestVItemRead “bane! RequestVItemRead “air_tii 4.1.1.7 RequestNVitemWrite RequestNV ItemiVrite allows for one NV write request to be scheduled to be sent to the phone. ‘The request itselfis built according to a description entered into the QXDM Pro database or the user database diag entity table, RequestNV Iteml\Vnite waits for the response and, if received, parses it according to the description in the QXDM Pro database or the user database diag entity tables Parameter Description NVitemName [Name ofthe NV item entity to write Fields Fleld values usedto build the request Usage example RequestlVitenlrite “banner” “My MSH7500° e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. “6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide Icons & Indicators 4.1.1.8 RequestNVitemIDRead RequestNV ItemIDRead allows one to schedule one NV read request to be sent to the phone. The request itself is built according to arguments entered as raw bytes. RequestNVItemIDRead waits for the response, reporting result status Parameter Description emNumber _| Rem number ofthe NV diag entity to be read RawBiytes | Optional lst of space-separated byte values used to build the NV item being read Usage example RequestVItemIDRead 71 RequestVItemIDRead 10 0 0 0 4.1.1.9 RequestNVitemIDWrite RequestNV ItemIDWrite allows one to schedule one NV write request to be sent to the phone. ‘The request itselfis built according to arguments entered as raw bytes. RequestNVItemIDWrite ‘waits for the response, reporting result status. Parameter Description TemNumber | Item number ofthe NV diag entity to be written RawBiytes | Optional ist of space-separated byte values used fo build the NV tem being witten Usage example RequestilVItemIDWrite 71 77 83 77 32 54 53 53 48 RequestilVItemIDWrite 10 0 0 0 4.11.10 SendRawRequest SendRawRequest allows one to schedule one diag request to be sent to the phone, The request itselfis built according to arguments entered as raw bytes. SendRawRequest waits for the response, reporting result status Parameter Description RawBytes | List of space-separated byte values used to build the diag request being sent Usage example SendRavRequest 39 71 0 77 83 77 32 54 53 53 48 SendRavRequest 0 e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. “e MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Icons & Indicators 4.1.1.41 Wait This halts scripting fora specified amount of time Parameter Description Time Time in seconds to wait Usage example Wait 10 4.1.1.12 WaitForitem WaitForltem allows you to register interest in and wait for an item The item name is the diag entity name in the QXDM Pro database or the user database diag entity table. Requests for asynchronous commands (logs, events, and debug messages) may result in a registration being sent to the phone. WaitForltem can also be used to wait for synchronous requests or responses. At the conclusion of the command, the registration is revoked. nore: WaitForltem only waits fora response. It does not make a request. Use Requestltem (see Section 4.1.1.5) or RequestNamedItem to request an item and wait for the response. Parameter Description TtemName | Name of diag entity to request Usage example WaitForItem EVENT_CALL_CONTROL_TERMINATED WaitForltem “Searcher and Finger” WaitF orltem “Get IS-2000 Status Response” 4.2 Quick Search Enable Quick search on views and view launch 4.3 Status bar ‘The Status bar displays a configurable subset of application statistics, application state indicators, and help for select mems commands (QSRA:Not Connected 0.00 8/5 0.00 8/s 1 0 56.02 KB 22 H:37 M:20 S 22:37:20.788 Status from left to right = Qshrinkd usage status a» RXrate = TXrate = Total number of packet received = Total number of packet dropped by device e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. av MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide Icons & Indicators a Total size of ISF file = Duration of the current QXDM session a Time stamp of the last received packet e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 4 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION5 COM Automation Interfaces Note: ‘The QXDM Pro application is a Windows Vista (and later) application that utilizes the existing diag serial interface via the Atlas/QPST phone server to establish a connection to a phone target Once a connection is established, QXDM Pro allows the user to manipulate and monitor the phone target by ultimately sending and receiving diag traffic to and from the target. QXDM Pro is, built upon the DM Core Framework, a library of objects and methods that encompasses all nonuser interface-related functionality implemented by QXDM Pro. This includes but is not limited to target connection management, target data partitioning, target data representation, and data storage and nonsequential data access. To support extensibility and rapid prototyping, QXDM Pro exports a subset of the DM Core Framework functionality through a set of COM interfaces. These interfaces allow QXDM Pro to support scripting through any COM-compliant scripting language, e.g, VBScript, JScript, and Peri, Additionally, a large subset of these interfaces is exposed through HTML-tased QXDM Pro views, Each view combines the capabilities of the Microsoft Intemet Explorer control, hosted ina QXDM Pro window, with the rich QXDM Pro COM interface capabilities, allowing both the QXDM Pro team and QXDM Pro users to create custom views ‘The QXDM Pro COM interfaces are roughly divided into five modules, each described in the following sections: = QXDM Professional - The QXDM Pro COM automation interface that existed and shipped in QXDM versions prior to 03.05.50; although these interfaces are still part of the QXDM. code base, itis intended that support for some of the interfaces will be phased out over time = Client — Provides a means to partition QXDM Pro items (data obtained from the target and intemal QXDM Pro processing) into unique collections, also provides direct access to QUDM Pro items = Client Config -Providesa means to configure the particular types of items in which a QUDM interface client is interested, ie, it defines the partition a client represents = Item — Interface to a particular item being managed by QXDM Pro a Field — Provides access to the QXDM Pro database parsed fields of a particular item. Numerous automation sample scripts (written in both Perl and JScript) can be found under the executable folder described in Section 2 2 (which is typically located in C:\Program Files (286)\Qualcomm\QXDM4\Automation Samples). eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.1 QXDM Pro interface ‘This section describes the legacy QXDM Pro COM interface. 5.1.1 AppVersion ‘The AppVersion property retums the version of QXDM Pro ABSTR valueis retumed. 5.1.2 ClearViewltems ‘The ClearViewltems() function clears al items in the specified view. Parameter Type Description Display Name BSTR | Name of display to clear, the name is interpreted as. + Item view-Item Store view + Messages view— Messages view + All others — Tagged ftered viewname ‘The function returns a VARIANT_BOOL response = FALSE —Request was not received (e.g, view was not found) a TRUE -Request was successflly received 5.1.3 COMPort ‘The COMPort property can be used to view the currently selected COM port or to change to another COM port for which QXDM Pro will attempt to connect to a phone A SHORT value is retumed: —Enror occurred = 0—Disconnect state = 1.n—COM port selected 5.1.4 CopyViewltems ‘The CopyViewltems() function copiesall items to an Item Store Format file Parameter Type Description Display Name BSTR | Name of display to copy, the name is interpreted as: + tem view-Item Store view + Messages view— Messages view + Log wew-Log view + Allothers— Tagged ftered viewname Destination File | BSTR | Name ofthe destination Item Store Format fle e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 50 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces ‘The function returns a VARIANT_BOOL response = FALSE —Request was not received (e.g, view was not found) a TRUE -Request was successflly received 5.1.5 CloseView ‘The CloseView() function allows you to close an existing QXDM Pro view. Parameter ‘Type Description pviewName BSTR _| Name of QXDM Pro viewto close p\iewTag BSTR | Windowtag for vieve that support multiple instances or empty string (") ‘The function returns a VARIANT_BOOL that indicates whether a view was closed. nore: Due to the unique operation of the QXDM Pro log view, this function does not apply to the QNDM Fro log view. 5.1.6 CreateView ‘The CreateView() function allows you to bring up a QXDM Pro view. Parameter Type Description pviewName BSTR _| Name of OXDM viewto bring up p\iewTag BSTR | Windowtag for views that support multiple instances or empty sting a) ‘The function returns a VARIANT_BOOL that indicates whether a view was created. Ifa view of the same name is already present and that view does not support multiple instances, the existing view will be brought to the forefront. In this case, success is retumed. nore: Due to the unique operation of the QXD QXDM Pro M log view, this function does not apply to the QXDM Pro log view. 5.1.7 DipSwitchMask The DipSwitchMasid) property is used to set DIP switch settings Parameter Type Description DIP switch value | SHORT _ | DIP switch valuesto set ‘The function returns no value. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.1.8 ExportViewText ‘The ExportViewText() function exports all items to a text file Parameter Type Description DisplayName | BSTR __| Name of display to export, the name is interpreted as: + Item view= Item Store view + Messages view— Messages view + Log view—Log view +All others — Tagged fitered viewname Name ofthe destination text fle Destination File | BSTR ‘The function retusa VARIANT_BOOL response: = FALSE —Request was not received (e.g, view was not found) a TRUE -Request was successflly received 5.1.9 IsPhoneConnected ‘The IsPhoneC onnected property retums 1 if QXDM Pro isin the phone Connected state and O otherwise. Use GetServerState (Section 5.2) to determine what Nonconnected state QXDM Pro is in ALONG value is retumed. 5.1.10 LoadConfig ‘The LoadConfig() function loads a configuration file( DMC) Parameter Type Config File STR Description Configuration fle (see Section 31 for details) ‘The function returns no response. 5.1.11 LoaditemStore ‘The LoadltemStore() function allows you to load an Item Store Format (* ISF) file into QXDM Pro Parameter Type Description FileName BSTR | Fully qualifed path to item Store Format fle ‘The function returns a VARIANT_BOOL that indicates whether the Item Store Format file was loaded. nore: An ISF can be loaded into QXDM Pro only when QXDM Pro isin the disconnected state. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.1.12 LogMask ‘The LogMas property is enabled for legacy reasons only. The LogMask property retums the log ‘mask that is configured for equipment ID 1 logging using the Log View ABSTR value is retumed in the format of the Log View Configuration dialog 5.1.13 LogMaskOff ‘The LogMaskOf{) function tums off log item for which the Log View is registered Parameter Type Description Log SHORT | LogiD orlog code EquipmentID [SHORT _ | Equipment iD ‘The function returns no response. 5.1.14 LogMaskOn ‘The LogMaskOn0 fiction tums on a log item for which the Log Viewis registered Parameter Type Description LogiD ‘SHORT [LogID orlog code EquipmentID | SHORT | Equipment ID ‘The function returns no response. 5.1.15 OfflineDigital ‘The OfflineDigital() function attempts to set the phone to the Offline Digital state. ‘The function returns a LONG value = 0—Failure to set the phone to Offline Digital state a 1 Successfully set the phone to Offiine Digital state 5.1.16 ResetPhone ‘The ResetPhone() function resets the phone ‘The function returns a LONG value = 0—Failure to reset the phone — Successfully reset the phone 5.1.17 SaveConfig ‘The SaveConfig() function saves a configuration file (.dme). e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 6a MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONCOM Automation Interfaces QXDM Professiona?™ v4 for Windows OS User Guide Description Configuration fle (see Section 31 for details) Parameter Type STR Config File ‘The function returns no response. 5.1.18 SendDmicdPacket ‘The SendDmilcdPacket() function is deprecated. Use SendDmlcdPacketE instead (see Section 5 1). 5.1.19 SendDmicdPacketEx ‘The SendDmilcdPacketEx0 function sends a DM requestiresponse packet to the target Parameter Type Description Packet VARIANT Safe array of bytesto send tothe target Timeout TONG Timeout value forthe request ‘The function retusa VARIANT that contains the response from the target. 5.1.20 SendScript ‘The SendScript( function sends a command to QXDM Pro to be executed on the QXDM Pro command line. Parameter Type Description ‘Command STR (Command string to execute ‘The function returns no value. 5.1.21 SetCDMAProtocolRevision ‘The SetCDMAProtocolRevision() function allows you to set the CDMA protocol revision that is used when parsing CDMA OTA iog items e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Parameter Type Description ULONG Desired CDMA protocol revision, possible values are = 0-I5-958 = 1-180 = 2-TBD = 3-TBD = 4-15-9568 = 5—TBD = 6-15-2000 Revo = 7-15-2000 Rev A = 8-15-2000 RevB = 9-15-2000 Rev C = 10-15-2000 Rev ¢ = 11-15-2000 RevD = OX7FFFFFFF — Automatic ‘The function returns no value. 5.1.22 SetWCDMAProtocolRevision ‘The SetWCDMAProtocolRevision() function allows you to set the WCDMA protocol revision that is used when parsing WCDMA OTA log items Parameter Type Description ULONG, Desired WCDMA protocol revision, possible values are + 01999 (RRC 25.331 V3.5.0- 12/00 3GPP) + 16/01 (RRC 25.331 V3.7.0) + 23102 (RRC 25.331 V3.A0) + 33/04 (RRC 25.331 V31.0) + 46104 (RRC 25.331 V5.9.0) + 512105 (RRC 25.331 V8.0) + 6-316 (RRC 25.331 V6.9.0) + 7-616 (RRC 25.331 V6.A0) + 8—9106 (RRC 25.331 V6.B.0) + OX7FFFFFFF — Automatic ‘The function returns no value. 5.1.23 SaveltemStore ‘The SaveltemStore() function allows function is subject to the same condit youto save a temporary item store format file (*isf). This tons as Save Items (see Figure 3-1) Parameter Type Description pFileName BSTR Fully qualifed fle name ofthe Item Store Format fle to be saved ‘The function returns no value. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces nore: When QXDM Pro is run, an ISF is created using a temporary name in the QXDM Pro ISF folder (typically Located at C:\Documents and Settings\All Users\Dacuments\Qual comm\QXDMAISF) ‘This is then used as the current ISF. Ifthe user (either through the interaction with the QXDM Pro GUI or through the QXDM Pro automation interface) initiates the loading of an existing ISF, the current ISF may be saved ifit is nonempty and the user has enabled Item Store saving In this case, the filename specified by SaveltemStore() is used to rename and move the current ISF. This process does not apply when the user has already loaded an emsting ISF 5.1.24 SetLoggingOn ‘The SetLoggingOn() fiction is deprecated. Use SetLoggingOnEx instead (see Section 5.1) 5.1.25 SetLoggingOnEx ‘The SetLoggingOnEx() function sets the log mask to the mask provided for the specified equipment ID and swatches logging on Parameter Type Description Log Mask BSTR Hexadecimal log mask in the Log View Configuration dialog format EquipmentiD | SHORT Equipment ID intended for log mask ‘The function returns no value. 5.1.26 SetLoggingOff ‘The SetLoggingOff() function sets the log filename to the name provided as a parameter and switches logging off Parameter Type Description Log flename BSTR Filename to use for logging ‘The function returns no value. 5.1.27 QuitApplication ‘The QuitApplication( function causes the QXDM Pro application to terminate ‘The function returns no value 5.1.28 QXDMTextOut ‘The QXDMTextOut() function adds a string to the Item Store Parameter ‘Type Description Text BSTR String o display in views that are registered to receive ‘Automation strings e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 8 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces ‘The function returns no value. 5.1.29 Visible ‘The Visible property can be used to get the Visible state of QXDM Pro or to show or hide the QUDM Pro server application. Parameter ‘Type Description Visible value | VARIANT_BOOL_[ QXDM Pro server application Visible state ‘The function retums a VARIANT_BOOL, 5.1.30 WaitEvent ‘The WaitEvent() function waits for an event from the target. It retums the event if received within. the timeout specified; otherwise, a VARIANT of type VT_EMPTY is retumed Parameter Type Description EventID LONG EventID for which to wait Timeout LONG Timeout value to wait ‘The function retums a VARIANT. 5.1.31 Requestitem ‘The Requestltem( function allows one or more requests to be scheduled for transmission to the target. The request itself is built according to a description entered into the QXDM Pro database diag entity table Parameter Tye Description PRequesNName | BSTR Tame of dag entity (ether @ dag request or subsystem dispatch request) Prields BST Fields used to buld he request bValuesOnly | VARIANT_BOOL | Does the pFields argument represent a string containing only the fleld values, or does t representa tly qualied flename representing a ext fle containing the full eld names and their values (such as generated by the QXOM Pro Item Tester application)? Timeout ULONG Base timeout value nme for request requestCount | ULONG Number of requests to schedule (must be at least one) Fequency ULONG Tithe requesiCount arguments greater than one, this represents the amount oftime (ims) between successive requests. ‘The function returns a unique request ID. Upon error, 0 is retuned, IfbValuesOnly is VARIANT_TRUE, then the format of pFields isa space-delimited string of field values where string field values are enclosed in quotes, i.e, OxFF 100A String” e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. ov MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces ‘This example specifies that the first field of the request has the value OxFF, the second field has the value 100, and the last field for the request has the value A String For fields that are enumerations, the raw value must be provided, i e., the integral value. IfbValuesOnly is VARIANT_FALSE, then pFields is the fully qualified name of the file that gives the fields and their values. The format of the file is one field/value pair per line where the field is separated from the value by the * character. For an example, see the QXDM Fro Item Tester application ‘The timeout argument is dependent on the QPST Server. Current builds of QPST Server automatically retry each request up to three times in the case of a timeout while waiting for the response. Thus, the total timeout value is the argument value times three, Due to the real-time nature of QXDM Pro, the maximum value for timeout is 2000 ms Ifthe requestCount argument value is greater than one, then the request is considered to be repetitive. The first request will be scheduled to go out immediately. Subject to target latencies and the number of requests in the diag server queue, the next instance of this request will be sent out frequency ms after the response to the first request is received (or a timeout occurs). Due to the real-time nature of QXDM Pro, the minimum value for the request frequency is currently 10ms. A value of OxFFFFFFFF for the request count indicates that the caller wants requests to be scheduled indefinitely. 5.1.32 RemoveRequest ‘The RemoveRequest() function allows you to cancel an existing request Parameter Type Description requestiD ULONG Unique request ID ‘The function retums a VARIANT_BOOL indicating success/failure. 5.1.33 GetServerState ‘The GetServerState() function allows you to retrieve the state of the QXDM Pro diag server. This isan extension of the previous IsComnected() function that takes no arguments and retusa ULONG. The ULONG retum value is one of the values listed below. val Description 0 Target is disconnected. This isthe intial state, which indicates that QXDM Pro is not connected to a target 1 ‘QXDM is about to be connected to a target, OXDM Pro has connectedto atarget via PST Server, but all up-font initialization has not yet occurred 2 Target has been verifed, QXDM Pro is connected{o a target and has successtully completed all up-front intilization. This currently consists of querying the target for version information, supported log items, and supported message levels, etc 3 ‘GXDM Pro is about to disconnect fom a target. Commands must be sent to the target to gett into a desired state. Once those commands are sent, QXDM Pro will transition to the Disconnected state. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. ee MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Value Description 7 Tn Playback mode, GXDM Pro isnt physically connected to a target. Rather, OXDM Pro is operating ftom a fle generated by a previous target connection. Async diag data is read fom that fle and distributed to interested parties as if connected toa lve target Note that playback can be reached only from the Disconnected state. OsFFFFFFFF | Error 5.1.34 GetitemCount ‘The GetltemCount() function allows you to retrieve the number of items in the current QXDM Pro Item Store. The function takes no arguments and retums a ULONG. The ULONG retum, value represents the total mumber of items in the Item Store (upon error 0 is retumed) 5.1.35 Getitem ‘The Getltem( function allows you to retrieve a particular item from the current QXDM Pro Item. Store. Parameter Type Description index ULONG Index ofitem fo retrieve (he item Store isindexed Oto the ‘number of tems returned by GetitemCount()—1) ‘The function returns an interface pointer to the QXDM Pro item interface model (IColoritem) 5.1.36 RegisterClient ‘The RegisterClient() function allows you to register asa client with QXDM Pro. A client represents a subset of the QXDM Pro Item Store whose contents are generally tailored to the needs of a particular display or scnpt. Parameter Type Description pClientName BSTR Name of dient or empty string (") bFiteredView | VARIANT_BOOL | Bring up @ GXDM Pro fitered viewlied to the client. Ifsetto \VARIANT_TRUE, a valid client name is required to be provided. Asthe fitered viewis tied to the client, t wll be restricted in functionality. The primary usage is intended to be for debugging user views and seripts ‘The function returns a ULONG that represents the unique client identifier (handle), Itis used in all subsequent client calls. Upon error OxFFFFFFFF is returned, 5.1.37 RegisterQueueClient ‘The Register QueueClient() function allows you to register asa client with QXDM Pro. A client represents a subset of the QXDM Pro Item Store whose contents are generally tailored to the needs of a particular display or script. This version differs from RegisterClient( in that the client that is created intemal to QXDM Pro is of fixed size, i€, only the last N items are available at any point in time. This allows for a more efficient representation that utilizes fewer system. resources and supports expedited processing e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. = MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Description Size of queue (he value must be 256, 512, 1024, 2048, 4096, 16384, or 65536) Parameter Type ‘queueSize ULONG ‘The function returns a ULONG that represents the unique client identifier (handle), Itis used in all subsequent client calls. Upon error OxFFFFFFFF is returned, 5.1.38 UnregisterClient ‘The UnregisterClient() function allows you to unregister an existing client. Parameter Type Description client ULONG, Unique handle of cient to unregister ‘The function retums a VARIANT_BOOL indicating success/failure. Ifa QXDM Pro filtered view was associated with the client, the view will be closed automatically by the interface. Note: 5.1.39 ConfigureClientByKeys ‘The ConfigureClientByK eys() function allows you to set the items an existing client is interested in processing Parameter Type Description Client ULONG, Unique handle of client to configure ‘an interface pointer to the QXDM Pro client config interface model 5.1.40 ConfigureClientByNames ‘The ConfigureClientB yNames() function allows you to set the items an existing client is interested in processing Parameter Type Description client ULONG Unique handle of client to configure Config BSTR Space-delimited names of diag entities in which client is interested in processing (each name must be in quotes) ‘The function retums a VARIANT_BOOL indicating success/failure. ‘The names come directly from the QXDM Pro DIAG entity table. The format isa list of space- delimited strings in quotes, ie, “EVENT_HDR_MSG_Rx” “IxEV-DO Active Set Pilot” “1xEV-DO State” “1xEV-DO Sector.” Note: Confidential and Proprietary — Qualcomm Technologies, Inc. e0-vi24.25 ¢ MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces ‘This example indicates that the client wishes to process the event with the ID 329, and the logs with IDs 0:105F and 01080. When (or if) QXDM Pro is connected to a target, it will configure the target to send the requested items. When an item amrives (either from the connected target or via QXDM Pro playback) matching the given event or logs, it will then be added to the client 5.1.41 ClearClientitems ‘The ClearClientltems() function allows you to empty an existing client of items Parameter ‘Type Description client ULONG [Unique handle of cient to empty ‘The function retums a VARIANT_BOOL indicating success/failure. nore: Ifa QXDM Pro filtered view was associated with the client, the view will be cleared automatically by the interface. In addition to this function, a client may be cleared when the current QXDM Pro Item Store is emptied (as all clients are subsets of the current Item Store) or ‘when an existing Item Store is loaded, replacing the current Item Store 5.1.42 GetClientitemCount ‘The GetClientltemC ount() function allows you to retrieve the number of items in the specified client. This will always be a number equal to or less than the number of items in the current QUDM Pro Item Store. Parameter Type Description Client ULONG Unique handle of client for which to obtain count ‘The function returns a ULONG. The ULONG retum value represents the total number of items in the client (upon error 0 is retumed) 5.1.43 GetClientitem ‘The GetClientltem( function allows you to retrieve a particular item from the specified client. Parameter Type Description Client ULONG Unique handle of client fom which to obtain tem index ULONG Index ofitem to retrieve (the client is indexed Oto the number of items returned by GetClientltemCount() —1). ‘The function returns an interface pointer to the QXDM Pro item interface model (IColoritem) e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.1.44 ClientRequestitem ‘The ClientRequestltem( function allows you to schedule one or more requests to be sent through the specified client. The request itselfis built according to a description entered into the QXDM Pro database diag entity table Parameter Type Description client ULONG (Unique handle of cent through which to request item pRequestName | BSTR Name of diag entity (ether a diag request or subsystem dispatch request) pFields| BSTR Fields used to build the request valuesOnly VARIANT BOOL | Does the pFields argument represent a string containing only the fleld values, or does it represent a fully qualifed flename representing a text file containing the full eld names and their values (e.g., generated by the QXDM Pro item Tester, application)? Timeout ULONG Biase timeout value in miliseconds for request TequestCount__| ULONG Number of requests o schedule (must be at least one) ‘frequency ULONG Tfthe requestCount argument is greater than one, then this represents the amount of time (in milliseconds) between successive requests. ‘The function returns a unique request ID. Upon error, 0 is retuned, IfbValuesOnly is VARIANT_TRUE, then the format of pFields isa space-delimited string of field values where string field values are enclosed in quotes, ic, OxFF 100A String” ‘This example specifies that the first field of the request has the value OxFF, the second field has the value 100, and the last field for the request has the value A String For fields that are enumerations, the raw value must be provided, i e., the integral value. If bValuesOnly is VARIANT_FALSE, then pFields is the fully qualified name of the file that gives the fields and their values. The format of the file is one field/value pair per line where the field is separated from the value by the * character For an example, see the QXDM Fro Item Tester application ‘The timeout argument is dependent on QPST Server. Current builds of QPST Server automatically retry each request up to three times in the case of a timeout while waiting for the response. Thus, the total timeout value is the argument value times three, Due to the real-time nature of QXDM Pro, the maximum value for timeout is 2000 ms Ifthe requestCount argument value is greater than one, the request is considered to be repetitive ‘The first request will be scheduled to go out immediately. Subj ect to target latencies and the number of requests in the diag server queue, the next instance of this request will be sent out frequency ms after the response to the first request is received (or a timeout occurs). Due to the real-time nature of QXDM Pro, the minimum value for the request frequency is currently 10 ms. A value of OxFFFFFFFF for the request count indicates that the caller wants requests to be scheduled indefinitely. Requests and the responses to them are automatically added to the client. Thus, there is no need. to register for each request and response type. Due to this it isimportant that the client exist for the duration of the requestiresponse cycle. Although QXDM Pro will continue to fumction ifthe client is removed (unregistered) prior to the request being transmitted or the response being received, relying on this behavior is not suggested. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces For subsystem dispatch V2 items, only the immediate response will appear in the client view. Registration for the delayed response is required for the client to receive any actual delayed response packets (see Section 5 2) 5.1.45 ClientRemoveRequest ‘The ClientRemoveRequest() function allows you to cancel an existing request Parameter Type Description client ULONG, Unique handle of cient requestiD ULONG Unique request ID ‘The function retums a VARIANT_BOOL indicating success/failure. 5.1.46 ClientRequestNVRead ‘The ClientRequestNVRead() function schedulesa single NV item read request to be sent through a specified client. The request is built according to a description entered into the QXDM Pro database DIAG entity table Parameter Type Description helient ULONG Unique handle ofthe client through which to request an item pNvitemNName | BSTR DIAG NVitem to request pFields| BSTR Fields used to buld the request bvaluesOnly VARIENT_BOOL | Flagto indicate ifthe pFields parameter represents a sting Containing only the feld values or @ text file containing the full field names and their values (as generated by the QXDM Pro item tester application) Timeout ULONG Base timeout value of the request in ms pvarbDualsia’ | VARIANT™ Optional input Enteredin the case of dual SIM Default is 0 ifno value is provided. pvarulContexiD | VARIANT™ Optional input — SIM ID, default is 0 Iino value is provided pErrortisg VARIANT” Optional output — Debug error messagesif error occurs ‘The function returns a unique request ID. Upon error, 0 is retuned, This function behaves ina manner consistent with the ClientRequestltem() function. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.1.47 ClientRequestNVWrite ‘The ClientRequestNVWrite() function schedules a single NV item write request to be sent through a specified client. The request is built according to a description entered into the QXDM Pro database DIAG entity table. Parameter Type Description nolient ULONG Unique handle ofthe client through which to request an tem pNVitemNName | BSTR DIAG NV item to request pFields BSTR Fields used to build the request bvaluesonly VARIENT_BOOL | Flagto indicate ifthe pFields parameter represents a sting Containing only the feld values or text file containing the full field names and their values (as generated by the QXDM Pro item tester application) Timeout ULONG Base timeout value of the request in ms pvarbDualsia’ | VARIANT™ Optional input Enteredin the case of dual SIM Default is 0 ifmo value is provided. pvarulContexiD | VARIANT™ Optional input — SIM ID, default is 0 Iino value is provided pErrortisg VARIANT” Optional output — Debug error messages if error occurs ‘The function returns a unique request ID. Upon error, 0 is retuned, This function behaves ina manner consistent with the ClientRequestltem() function. 5.1.48 CopyClientitems ‘The CopyClientltems() function allows you to copy all ora portion of the items ofa client toa new Item Store Format file Parameter Type Description client ULONG, Unique handle of alent fom which fo copy tems pFileName BSTR Filename ofnew ist fie startindex ULONG Client index of frst tem to copy endlndex. ULONG Client index oflast fem to copy ‘The function retums a VARIANT_BOOL indicating overall success/failure ‘The index parameters give the range of items to copy. The start index must be less than or equal to the end index. Ifthe end index is greater than the number of items in the client, the actual index used wall be one minus the number of items in the client, i e., to always copy the entire contents ofa client to the new file store without regard to the current size of the client, (0, OxFFFFFFFF) should be specified Nore: This operation may take a nontrivial amount of time to complete, depending on the number of items managed by the client and the parameters to the function. While it executes, the function vill not retum. However, the QXDM Pro interface will continue to respond to additional commands. Due to this, care must be taken in ensuring that the client is neither unregistered nor emptied asynchronously while a copy-items operation on the client is executing e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 08 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.1.49 SyncToltem ‘The SyncToltem() function allows you to sync item list-based views toa given item index. Parameter Type Description Index ULONG Item Store index ofthe item to syncto bSyncexact__| VARIANT_BOOL | Iftrue, syncto the exact index otherwise, sync to the nearest tem ‘The function retums a VARIANT_BOOL indicating overall success/failure 5.1.50 SyncToClientitem ‘The SyncToClientltemQ function allows you to synca client item list-based view to a given item. index Parameter Type Client ULONG Unique handle of cient view Index ULONG Client index ofthe tem to syncto bSyncEvact__| VARIANT_BOOL_[iftrue, syncto the exact index otherwise, syncto the nearest item ‘The function retums a VARIANT_BOOL indicating overall success/failure 5.1.51 ClientRequestNVName ‘The ClientRequestNVName() function gets the NV’ item path name for given a NV item ID. Parameter Type Description helient ULONG Unique handle ofthe client through which to request an item pNVitemiD ULONG DIAG NV item ID to request pNVitemName | VARIANT™ Optional output — Name ofDIAG entity to request (must be an NVitem) pErrortisg VARIANT” Optional output — Debug error messages if error occurs ‘The function returns a unique request ID. Upon error, 0 is retuned, 5.2 Client Config interface (IClientC onfig) ‘This section describes the QXDM Pro Client Config interface (IClientConfig). 5.2.1 ClearConfig ‘The ClearConfig() function allows you to clear a client config In the Cleared state, a client will only receive items originated through the ClientRequestltem(), ClientRequestNVRead(), and ClientRequestNVWnite() functions. This function takes no arguments and retums no value e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 65 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.2.2 CommitConfig ‘The CommitConfig () function is typically the last function called when adjusting the config ofa client All changes made to the client config are updated within QXDM Pro when CommitC onfig( is called. This function takes no arguments and retumns no value 5.2.3 Additem ‘The Addltem( function allows you to request that items of the specified type are added to the client as they are processed by the current QXDM Pro Item Store. The function does not retumn a value. Parameter Type Description itemType ULONG Desireditem type, possible values are: + 0—Malformed diag entity +1 Target diag response (minus following) + 2—Target diag request (minus following) + 3=GPS information + 4—Target event + 5—Target log 6—Target message 7 Generic strings 8—Target OTA og 9— Target subsystem dispatch response 10 Target subsystem dispatch request Nore: Contrary to subsequent functions that request items ofa particular subtype, this function does not actively register with the target for the given items ‘This form of registration is equivalent to checking an Item Type from the Item List Config ofa QUDM Pro Filtered View 5.2.4 AddDIAGRequest ‘The AddDIAGRequest() function allows you to request that outgoing diag requests with a specified diag command cade be added to the client. The function does not retum a value Parameter Type Description ond ULONG Diag command code ofitemsin which client is interested Nore: This is not the same as building and scheduling a request via ClientRequestItem(). This simply adds outgoing diag requests of a particular command cade to the client as they are processed by the Item Store. The actual request may have onginated from another QXDM Pro subsystem. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 08 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.2.5 ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box Checlcand select diag requests from the Item Types list. Check Filter/Register On Target For Items. Selecta particular diag request command code from the subtype list (such as Version Information Request) In the above example, all diag requests with command code 0 would be added to the client regardless of where they originated. AddDIAGResponse ‘The AddDIAGResponse() fimction allows you to request that incoming diag responses witha specified diag command cade be added to the client. The function does not retum a value Parameter_| Type Description ond ULONG [Diag command code ofitems in which clients interested Nore: This is not the same as building and scheduling a request via ClientRequestItem(). This simply adds incoming diag responses of a particular command code to the client as they are processed by the Item Store. The actual response may have originated froma diag request made by another QXDM Pro subsystem or from QXDM Pro playback: ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box 2. Checkand select diag requests from the Item Types lis. 3. Check Filter/Register On Target For Items. 4. Select a particular diag request command code from the subtype list (such as Version Information Request) In the above example, all diag requests with command code 0 would be added to the client regardless of where they originated. 5.2.6 AddSubsysRequest ‘The AddSubsysRequest() function allows you to request that outgoing diag subsystem dispatch. requests with a specified diag subsystem ID and subsystem command code be added to the client ‘The function does not retum a value Parameter | Type Description ‘ubsySi0__| ULONG | Diag subsystem dispatch ID ofifems in which clent is interested ‘subsysyOmd [ULONG [Diag subsystem dispatch command code of femsin which dient is interested Nore: This is not the same as building and scheduling a request via ClientRequestItem(). This adds outgoing diag subsystem dispatch requests of a particular ID and command code to the client as sovi2s25.¢ Confidential and Proprietary ~ Qualcomm Technologies. Ine ov MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces they are processed by the Item Store, The actual request may have originated from another QX. QXDM Pro DM subsystem ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box Checlcand select Subsystem Dispatch Requests from the Item Types list Check Filter/Register On Target For Items. Selecta particular subsystem ID and command code from the subtype list (such as WCDMAVVersion Request, In the above example, all diag subsystem dispatch requests with subsystem ID 4 and subsystem command code 0 would be added to the client regardless of where they originated. 5.2.7 AddSubsysResponse ‘The AddSubsysResponse() function allows you to request that incoming diag subsystem dispatch responses with a specified diag subsystem ID and subsystem command code be added to the client. The function does not retum a value Parameter Type Description ‘subsysiD ULONG Diag subsystem dispatch ID ofitems in which cient isinterested ‘subsysyomd ULONG Diag subsystem dispatch command code ofitems in which cient isinterested Nore: This is not the same as building and scheduling a request via ClientRequestItem(). This adds outgoing diag subsystem dispatch requests of a particular ID and command code to the client as they are processed by the Item Store. The actual response may have originated froma request made by another QXDM Pro subsystem or from QXDM Pro playback ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box Checlcand select Subsystem Dispatch Responses from the Item Types list Check Filter/Register On Target For Items. Selecta particular subsystem ID and command code from the subtype list (such as WCDMAV" ersion Response) In the above example, all diag subsystem dispatch responses with subsystem ID 4 and subsystem command code 0 would be added to the client regardless of where they originated. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 08 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.2.8 AddEvent ‘The AddEvent() function allows you to request that incoming events witha specified event ID be added to the client. The function does not retum a value Parameter Type Description evertiD ULONG EventID offtemsin which dient isinterested Nore: This function results in the on-target event mask (if supported) being adjusted to include the specified event ID ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box 2. Checland select Event Reports from the Item Types list. 3. Check Filter/Register On Target For Items. 4. Select a particular event ID from the subtype list (such as EVENT_BAND_CLASS_CHANGE). In the above example, all events with ID 256 would be added to the client regardless of where they onginated 5.2.9 AddLog ‘The AddLog() function allows you to request that incoming logs with a specified log code be added to the client. The function does not retum a value Parameter Type Description Togtode ULONG Lag code offtems in which dient is interested Nore: This function results in the appropriate on-target log mask being adjusted to include the specified log code. Also note that QXDM Pro breaks out specific OTA log packets in order to provide additional functionality. Attempting to register from OTA log packets using Addlog() wall not produce the desired behavior ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box 2. Checkand select Log Packets from the Item Types list 3. Check Filter/Register On Target For Items. 4, Select a particular log code from the subtype list (suchas General Temporal Analyzer), In the above example, all logs with log code 01019 would be added to the client regardless of where they onginated sovi2s25.¢ Confidential and Proprietary ~ Qualcomm Technologies. Ine 6 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.2.10 AddMessage Note: ‘The AddMessage() function allows you to request that incoming debug trace messages witha specified subsystem ID and message level be added to the client. The function does not return a value Parameter Type Description ‘subsysiD ULONG: ‘Subsystem ID ofitemsin which clent is interested Tevel ULONG Message level (under above subsystem ID) offtems in which client is interested ‘This function results in the appropriate on-target message mask being adjusted to include the specified debug message. ‘This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box Checlcand select Message Packets from the Item Types list. Check Filter/Register On Target For Items. Selecta particular subsystem ID and message level from the subtype list (such as Legacy/Fatal), In the above example, all debug messages with subsystem ID 0 and message level 4 would be added to the client regardless of where they originated. 5.2.11 AddString ‘The AddStringO) function allows you to request that string items of the specified subtype are added to the client as they are processed by the current QXDM Pro Item Store. The function does not retum a value Parameter Type Description ‘stringType ULONG Desired string item subtype, possible values are: + 0 Informational string +1 Warning string + 2-Error string + 3— Automation sting + 4—Connection state string Nore: This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box 2. Checkand select Strings from the Item Types list 3. Check Filter/Register On Target For Items. 4, Select a particular string subtype from the subtype list (such as Automation), sovi2s25.¢ Confidential and Proprietary ~ Qualcomm Technologies. Ine 7 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona™ v4 for Windows OS User Guide COM Automation Interfaces In the above example, all strings originating from the QXDM Pro automation subsystem (or QXDM Pro playback of an automation string) will be added to the client 5.2.12 AddOTALog ‘The AddOTALog() function allows you to request that incoming OTA logs with a specified log code and message type key be added to the client. The function does not retum a value Parameter Type Description TogCode ULONG Log code ofitemsin which cient is interested key VARIANT (VT_ARRAY]VT_UI4) [Message type hey (specific to log code) Nore: This function results in the appropriate on-target log mask being adjusted to include the specified log code Table5-1 OTA log codes/keys — CDMA. QUDM Pro currently treats the log codes in Table 5-1 through Table 5-6 as OTA logs. The composition of each key is provided as well. Code Description Key oxt004 ‘CDMA access channel Single-entry array (message type) ox 005 ‘CDMA reverse traffic channel Single-entry array (message type) ox 005 (CDMA syne channel Single-eniry array (message type) ox 007 (CDMA paging channel Single-entry array (message type) ox1008 ‘CDMA forward traffic channel Single-entry array (message type) ox1090 CDMA forward dedicated control channel __| Single-entry array (message type) ox1091 CDMA reverse dedicated control channel _| Single-entry array (message type) ox 006 (CDMA forward broadcast control channel | Single-entry array (message type) (Ox1007 CDMA reverse enhanced access channel__| Single-entry array (message type) ox 008 ‘CDMA forward common contral channel Single-entry array (message type) ox 388 (CDMA (from UMTS) paging channel Single-entry array (message type) x88 ‘COMA (fom UMTS) forward traffic channel | Single-entry array (message type) x1 385 (CDMA (from VolP) paging channel Single-entry array (message type) x 38C ‘CDMA (from VolP) access channel Single-eniry array (message type) x 38D ‘CDMA (fom VolP)forvardtaffc channel | Single-entry array (message type) Table 5-2 OTA log codesikeys - CDMA 1xEV-DO Code Description Key Ox1076 _| 1xEV-DO access channel Two-entry array (protocol, message type) Ox1077 __| TxEV-DO reverse traffo channel Two-entry array (protocol, message type) (0x1078 | 1xEV-DO directed control channel Two-entry array (protocol, message type) Ox1079__| TxEV-DO forward Waffle channel Two-entry array (protocol, message type) ‘Ox107C | TxEV-D0 broadcast control channel Two-entry array (protocol, message type) e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. n MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Code Description Key Ox1085 | THEV-DO MAC access channel Empty 0x086 | TxEV-DO MAC control channel Empty Table 5-3 OTA log codesikeys - GSM Code Description Key OxS12F | GSM radio resource Two-entry array (channelidirection, message type) 0x8228 | GSM medium access control Two-entry array (channelidirection, message type) (0x5230__ | GSM sessionimobilty management Two-entry array (direction, message type) Table 5-4 OTA log codes/keys — UMTS Code Description Key Ox713A__ [UMTS NAS layer Two-entry array (protocol, message type) Table 5-5 OTA log codesikeys — WCDMA Code Description Key (Ox412F __ | WCDMA radio resource control Two-entry array (channel, message type) Table 56 OTA log codesikeys — Bluetooth Code Description Key (ox1048 | Bluetooth LMP Rx Empty (0x1049__| Bluetooth LMP Tx Empty ‘ox1046__| Bluetooth L2CAP Rx Empty Ox1040__| Bluetooth L2CAP Tx Empty 0x1052 | Bluetooth RFCOMM Rx Empty ox1053__| Bluetooth RFCOMM Tx Empty Nore: This form of registration is equivalent to the following actions ina QXDM Pro Filtered View. 1, Bringup the Item List Config dialog box Acccess/Registration) In the above example, all OTA logs with Log code 011004 and message type | would be added to the client regardless of where they originated. Checkcand select Log Packets (OTA) from the Item Types list. Check Filter/Register On Target For Items. Selecta particular log code and message type from the subtype list (such as e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.2.13 AddOTALogByString Note: ‘The AddOTALogB yString( function allows you to request that incoming OTA logs with a specified log code and message type key be added to the client. The function does not retum a value Parameter Type Description TogCode ULONG Log code offtems in which client is interested pkey BSTR Message type Key (specific to log code) expressed as a string of ‘space-delimited values This function operates in the same fashion as AddOTALog(). The sole difference is that the message type key is passed asa string consisting of space-delimited values, ie.,“5 67". The intended use is in scripting languages that do not easily support constructing and manipulating VARIANT arrays of simple types, such as VB Script and JScript. SetSubsysV2DelayedResponsesOnly The SetSubsys\’2DelayedResponsesOnly() function allows you to configure. client that wall receive only the delayed subsystem dispatch V2 responses (as opposed to both the immediate and delayed responses). Since both V2 and V1 responses are treated as the same item type, this makes certain types of filtering and item processing more convenient. The function does not retum a value. Parameter ‘Type Description BDelayedonly __| VARIANT_BOOL_| Accept only delayed responses Iftue 5.3 Item interface (IColorltem) ‘This section describes the QXDM Pro Item interface (IColorltem). 5.3.1 GetltemType ‘The GetltemType() function allows you to retrieve the item type of the current color item. The function takes no arguments and retums a ULONG value. The ULONG retum value is one of the values shown in Table 5-7. Table 5-7 Getitem Type return values Value Description Malformed diag entity Target diag response (minus following) Target diag request (minus folowing) GPS information Target event Target log Target message e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 73 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces Value Description 7 Generic sings a Target OTAlog @ Target subsystem dispatch response 10 Target subsystem dispatch request OsFFFFFFFF | Error 5.3.2 GetltemTypeText ‘The GetltemTypeText0 fiction allows you to retrieve the item type converted toa string The function takes no arguments and returns a BSTR value ‘The string retumed will be identical to the contents of the Type column in any QXDM Pro list- based view, 5.3.3 GetitemColor ‘The GetltemColor) fimction allows you to retrieve the color of the current color item. The function takes no arguments and retums a ULONG value. The ULONG retum value isin the form ofa standard Windows COLORREF value, i.e, three 8-bit values (R, G, B) packed into a 32-bit space. Upon return, (0, 0, 0) is retuned. This represents black, an invalid value in QXDM Pro, as that isthe color ofall item list backgrounds 5.3.4 GetltemTimestamp ‘The GetltemTimestamp() function allows you to retrieve the generic timestamp of the current color item. The function takes no arguments and retums a standard Windows DATE value (VT_DATE). ‘The generic timestamp represents the time the color item was created, i, whenit first entered the current Item Store. Thisis not the same as the item-specific timestamp, which is assigned to the item by the target 5.3.5 GetltemTimestamp2 ‘The GetltemTimestamp2( function allows you to retrieve the generic timestamp of the current color item. The function takes no arguments and retums a standard Windows DATE value asa double precision floating point number (VT_R8). ‘The generic timestamp represents the time the color item was created, i, whenit first entered the current Item Store. Thisis not the same as the item-specific timestamp, which is assigned to the item by the target. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 74 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.3.6 GetitemTimestampText ‘The GetltemTimestamp Text() function allows you to retrieve the generic item timestamp converted toa string The function retums a BSTR, Parameter Type Description bivantDate VARIANT BOOL [include the date Wanthllisecs | VARIANT_BOOL_| Include ms ‘The string retumed will be identical to the contents of the Timestamp column in any QXDM Pro list-based view 5.3.7 GetitemSpecificTimestamp ‘The GetltemSpecificTimestamp( fimction allows you to retrieve the item-specific timestamp of the current color item. The function takes no arguments and returns a standard Windows DATE value (VT_DATE) ‘The item-specific timestamp represents the time assigned to the item by the target. Ifthe item does not support a target-assigned timestamp, then the generic timestamp will be retumed instead. 5.3.8 GetitemSpecificTimestamp2 ‘This function allows you to retrieve the item-specific timestamp of the current color item The function takes no arguments and retumsa standard Windows DATE value as. double precision floating point number (VT_R8) ‘The item-specific timestamp represents the time assigned to the item by the target. Ifthe item does not support a target-assigned timestamp, then the generic timestamp will be retumed instead. 5.3.9 GetitemSpecificTimestampText ‘The GetltemSpecificTimestampText() function allows you to retrieve the item-specific timestamp converted toa string Parameter Type Description bivantDate VARIANT_BOOL [include the date bWanthilisess VARIANT BOOL | Include milliseconds ABSTR valueisretumed ‘The string retumed will be identical to the contents of the Timestamp column in any QXDM Pro list-based view. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 78 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.3.10 GetitemBuffer ‘The GetltemButfer() function allows you to retrieve the raw buffer of the current color item. Parameter Type Description VARIANT_BOOL | Return the fllitem buffer, including the header dened by QXDM Pro or simply the payload defined by QXDM Pro bindudeHeaderByies ‘The function returns a VARIANT array (V'T_ARRAY | VT_UI1) when successful. When an error occurs, an empty VARIANT array is retumed. However, as the payload defined by QXDM Pro may itself be empty, this is not a reliable way of determining iff true error occurred. 5.3.11 GetitemDLFBuffer ‘The GetltemDLFBuffer() function allows you to retrieve the raw buffer of the current color item adjusted to be compatible with the legacy DLF log file format. ‘The function returns a VARIANT array (V'T_ARRAY | VT_UI1) when successful. When an error occurs, an empty VARIANT array is retumed. 5.3.12 GetitemBufferText ‘The GetltemBufferText() function allows you to retrieve the raw buffer of the current color item converted toa string. The function retums a BSTR, Description ‘Return the fll item buffer, including the header defined by QXDM Pro or simply the payload defined by QXDM Pro, Parameter ‘Type bincudeHeaderBytes | VARIANT_BOOL ‘The string retumed will be identical to the contents of the Payload column in any QXDM Pro list- based view. 5.3.13 GetitemKeyText ‘The GetltemK eyText() function allows you to retrieve the item key converted toa string The function takes no arguments and returns a BSTR value ‘The string retumed will be identical to the contents of the Key column in any QXDM Pro list- based view. 5.3.14 GetitemName ‘The GetltemName() function allows you to retrieve the item name. The function takes no arguments and retumsa BSTR value ‘The string retumed will be identical to the contents of the Name column in any QXDM Pro list- based view. The item name represents the item key mapped to a string defined in the appropnate QUDM Pro database category/reference table. Confidential and Proprietary — Qualcomm Technologies, Inc. e0-vi24.25 ¢ MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.3.15 GetitemSummary ‘The GetltemNameSummary() function allows you to retrieve the item summary. The function takes no arguments and returns a BSTR value ‘The string retumed will be identical to the contents of the Summary column in any QXDM Pro list-based view. The item summary represents a summary of the item payload generated either by intemal QXDM Pro processes, the QXDM Pro database structure definition in combination with a QXDM Pro database format specifier, or an extemal dynamic item parsing DLL. 5.3.16 GetitemSize ‘The GetltemSize() function allows you to retrieve the item size of the current color item The function returns a ULONG value representing the size in bytes of the item. Parameter Type Description indudeHeaderBytes | VARIANT_BOOL | Retum the fllltem aize, including the header defined by ‘QXDM Pro or simply the payload defined by QXDM Pro sessional 5.3.17 GetitemParsedText ‘The GetltemParsedText() function allows you to retrieve the item full parsed text. The function takes no arguments and returns a BSTR value ‘The string retumed will be identical to the contents of the bottom right pane in any QXDM Pro list-based view (currently excludes the database parsed field list), The item full parsed text isa full description of the item payload generated either by intemal QXDM Pro processes, the QUDM Pro database structure definition, an external dynamic item parsing DLL, or (in the case of OTA logs) SILK. 5.3.18 GetitemFieldValue ‘The GetltemPieldValue() finction allows you to retrieve the actual value of a field parsed out of the item buffer. Typical applications of this function would be to parse items that cannot be described by the database or to extract fields out of the header of an item Parameter Type Description fieldType ULONG Type of feld to obtain (see Table &5) bitCount ULONG Number ofbitsto extract bitOTfeet ULONG Offset into item buffer to begin extraction bindudeHeaderSytes_| VARIANT_BOOL_| Include the header in tem buffer ‘The function returns a VARIANT. In the case of an error, an empty VARIANT (VT_EMPTY) is retumed. Table 5-8 shows the types of supported fields e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 7 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Table 5-8 Supported field types Type Value_| VARIANT type Description BOOL 0 Vi_B00L Boolean (tuerfalse) INTS 1 vit bit signed value uINTa 2 Vvi_unt 2bit unsigned value INTIS 3 Viz 16-bit signed value UINTIE 4 Vi_uIZ 16-bit unsigned value INTS2 3 Via 32.bit signed value UINTS2 6 Vi_uis 32.bit unsigned value INTes 7 Wie (64-bit signed value UINTEs 8 Vi_uie 64-bit unsigned value ANSISting [8 Vi_BSTR ‘ANSI string (fred length given by bitCount) UNICODE 10 Vi_BSTR UNICODE string (Bred length given by BiCount) String | ANSISting [17 Vi_BSTR ‘ANSI string (NULL terminated, bitCount ignored) UNICODE 2 Vissi UNICODE string (NULL terminated, bitCount ignored) String | FLOATS 3 Vie IEEE 32-bit foating point value FLOATE# 8 VRS IEEE 64-bit foating point value 5.3.19 GetitemFieldValueText ‘The GetltemPieldValueText() function allows you to retrieve the text representation of the field value parsed out of the item buffer. Parameter Type Description fieldType ULONG Type of eld to obtain (see Table 5-8) bitCount ULONG Number of itsto extract BHOTSet ULONG Offset into item butler to begin extraction bindudeHeadeytes | VARIANT_BOOL | Include the header in tem buffer Hexadecimal VARIANT_BOOL | Format feldtent as hexadecimal ‘The function returns the field value asa VT_BSTR and operates in the same manner as GetltemFieldValue described above 5.3.20 GetitemFields ‘The GetltemPields() function allows you to retrieve the QXDM Pro structure database representation of the current color item. The function takes no arguments and retums an interface pointer to the QXDM Pro database parsed field interface model (IColorltemPields) as discussed in Section 5 4 e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 78 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.3.21 GetNameditemFields ‘The GetNameditemFields() function allows you to retrieve the QXDM Fro structure database representation of the current color item. The function takes a single argument and retums an interface pointer to the QXDM Pro database parsed field interface madel (IColorltemPields) as discussed in Section 5 4 Parameter Type Description pentityName [BST Unique diag entity name ‘The function operates in a manner consistent with GetltemFields() with the exception that a unique diag entity name is passed by the caller. The name identifies/selects the structure definition that is used to parse the current item If the name is empty, then the function operates evactly as GetltemFields0, i.e, the default structure definition is used. The QXDM Pro database defines default as the first structure definition added to the database for a particular diag entity key. Since the QXDM Pro database is always loaded before any user database, this implies that the structure definition (when present) in the QXDM Pro database is the default. Should the QUDM Pro database not define a structure fora given diag entity key, then the default is dependent on the contents and load order of the user databases. The current QXDM Pro behavior is for the load order to be alphabetical by user database name. Note that this behavior may change inthe future 5.3.22 GetConfigureditemFields ‘The GetConfiguredltemFields() function allows you to retrieve the database parsed item fields of the current color item For applications that process a large number of items per sec or process items that parse to a large number of fields, setting bFieldStrings and/or bFieldNames to false will improve performance and/or is usually dependent on whether you need field strings or not. Generally, you only need field strings if you are dealing with a structure that contains enumerations and you need to display the mapped enumeration value strings Parameter Type Description entityName | LPCTSTR Diag entity name (fthis is not given then the default structure associated wih this entity will be used, e., GetitemFields() behavior) bFieidSWings | VARIANT_BOOL | Generate string representations of feld values bFicldNames | VARIANT BOOL _| Generate partial feld names ‘The function returns an interface pointer to the QNDM Pro database parsed field interface model, IColorltemFields (Section 5 4) Nove: If bFieldStrings is set to false, retrieving the string representation of fields will not be available. If bFieldNamesis set to false, searching for the index of. field by name will not be available 5.4 Field interface (IColorltemFields) ‘This section describes the QXDM Pro database parsed Field interface (IColoritemFields), e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 7 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM ProfessionaM™ vé for Windows OS User Guide COM Automation Interfaces 5.4.1 GetXML ‘The GetXMLO function allows one to retrieve the database parsed fields as an XML-formatted string The function takes no arguments and returns a BSTR value ‘The format of the XML is given in the following (partial) example Searcher And Finger Transmit Diversity Pilot 0 0 1 0 This function is intended to craft simpler HTML-based QXDM Pro views using XML transformations. In some cases, there may be an additional performance increase when using XML, asit should result in fewer COM interface classes than iterating over the list of fields. 5.4.2 GetFieldCount ‘The GetFieldCountQ function allows you to retrieve the number of parsed fields generated by the database parser. The function takes no arguments and retums a ULONG value 5.4.3 GetFieldindex ‘The GetFieldlndex() function allows you to retrieve the index of the first field matching the specified field name. Parameter Type Description pName BSR Name (ether fully qualifed or patil) ofthe feld for which to find the index bPartial VARIANT_BOOL | Isthe frst argument a partial feld name? ‘The function returns a ULONG that represents the index into the parsed field list matching the specified field name. The field list itselfis indexed 0 up to but not including the value retumed by GetFieldCount(), In the case of an error, the value Ox FFFFFFF is retumed. For the purposes of reducing search time, subsequent calls start from one beyond the last indexx retumed by this method. If the provided field name is not found before reaching the end of the field list, the search wraps around to the first field and proceeds until the provided field name is, found or the last index retumed is reached. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. Ey MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces 5.4.4 GetFieldindexFrom ‘The GetFieldIndexFrom() function allows you to retrieve the index of the first field matching the specified field name starting the search from the provided field index Parameter Type Description pName BSTR Name (ether fully qualifed or partial) ofthe field for which to find the index Startindex ULONG Tradex of field to start the search From Partial VARIANT_BOOL_| Tsthe frst argument a partial feld name? Loop VARIANT _BOOL | Ifthe feld name isnot found before reaching the end ofthe field ist, loop back to beginning of the fleld list? ‘The function returns a ULONG that represents the index into the parsed field list matching the specified field name. ‘The index retumed affects the start index of GetFieldlndext) as described above. 5.4.5 GetFieldindexBylD ‘The GetFieldindexB yIDQ function allows you to retrieve the index of the first field matching the specified field ID. The field ID is the identifier assigned to the field when it added to the DM database Parameter ‘Type Description FelaD ULONG, TD ofthe feld for which to tnd the index ‘The function returns a ULONG that represents the index into the parsed field list matching the specified field ID. The field list itselfis indexed 0 up to but not including the value retumed by GetFieldCount() In the case of an error, the value Ox FFFFFFF is retumed. For the purposes of reducing search time, subsequent calls start from one beyond the last indexx retumed by this method. Ifthe provided field name is not found before reaching the end of the field list, the search wraps around to the first field and proceeds until the provided field name is found or the last index retumed is reached. 5.4.6 GetFieldindexFromBylD ‘The GetFieldIndexFromByIDO function allows you to retrieve the index of the first field ‘matching the specified field ID starting the search from the provided field index Parameter Type Description FelaD ULONG TD ofthe feld for which to fnd the index Startindex ULONG Tndex of feld to dart the search fom ‘Loop VARIANT _BOOL | Ifthe feld name isnot found before reaching the end ofthe feld list loop back to beginning ofthe feld list? e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. et MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces ‘The function returns a ULONG that represents the index into the parsed field list matching the specified field ID. The field list itselfis indexed 0 up to but not including the value retumed by GetFieldCount(), In the case of an error, the value Ox? FFFFFFF is retumed. ‘The index retumed affects the start index of GetFieldindexB yIDO as described above. 5.4.7 GetFieldOffset ‘The GetFieldOffset() function allows you to retrieve the bit offset of the field identified by the given field index Parameter Type Description index ULONG, Field index ‘The function returns a ULONG representing the bit offset from the start ofthe payload defined by QUDM Pro of the specified field. In the case of an error, the value OxFFFFFFFF is returned, 5.4.8 GetFieldSize ‘The GetFieldSize() fiction allows for retrieval of the bit size of the field identified by the given field index. Parameter Type Description index ULONG, Field index 5.4.9 GetFieldValue ‘The GetFieldValue() function allows yt ‘The function retusa ULONG. In the case ofan error, the value OxFFFFFFFF is retumed. ‘ou to retrieve the raw value of the field identified by the given field index Parameter Type Description index ULONG Fieldindex 59. ‘The function returns Table 5-9 Supported field types a VARIANT. In the case of an error, an empty VARIANT (VT_EMPTY) is etumed. The QXDM Pro structure database supports the destination field types shown in Table Type VARIANT Type Description BOOL Vi_BOOL Boolean (rueffalse) INTs vt bit signed value UINTE Vint Sit unsigned value INTIS Wa 16.bit signed value UINTIE Vi_uz “16-bit unsigned value e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONQXDM Professiona?™ v4 for Windows OS User Guide COM Automation Interfaces Type VARIANT Type Description TINTS? Wt ‘Sob signed value UINTS2 Virus ‘SD. unsigned value INTEs We 4-bit signed value uINTes Vue 64-bit unsigned value ‘ANSI String VI_BSTR ANSI string UNICODE String | VT_BSTR UNICODE string FLOATS WRa IEEE S2:bit foating point value FLOATES VRS TEE 64-bit foating point value SignedEnum | VII ‘Signed enumeration Unsigned nam —_[VT_uia Unsigned enumeration 5.4.10 GetFieldName ‘The GetFieldName() function allows yt ‘ou to name the field identified by the given field index Parameter ‘Type Description index ULONG: Fieldindex Partial VARIANT_BOOL | Retum partial feld name? ‘The function returns a BSTR representing the field name A partial field name is equivalent toa fully qualified field name minus the leading diag entity name and field delimiter (“") 5.4.11 GetFieldValueText ‘The GetFieldValueText() function allows you to retrieve the value of the field identified by the given field index expressed asa string Parameter Type Description index ULONG Field index ‘The function retusa BSTR, As opposed to the field value, the field value text includes maps enums fields to their associated enum entry name. e0-vi24.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Inc. 2 MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATIONA References A.1 Acronyms and terms ‘Acronym or term Definition ANS ‘Advanced mobile subscriber sation APU ‘Application processing unit Duc Diagnostic monitor configuration DMSS Dual-made subsorber station ouT Greenwich mean time cur Graphical user interface: MPU Modem processing unit OTA Oversthe-air oF (ualcomm license fle OuMs (Qualcomm license management system OxoM (Qualcomm extensible diagnostic monitor UE User equipment eo-vi24t.25 ¢ Confidential and Proprietary — Qualcomm Technologies, Ine. MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION