PASTA Python APIs

Programming Guide

Doc No:
Version: V1.3
Release date: 2020-02-24
Classification: Confidential B

© 2008 - 2020 MediaTek Inc.

This document contains information that is proprietary to MediaTek Inc.
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Specifications are subject to change without notice.

 MediaTek Confidential
PASTA
Programming Guide

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

This document contains information that is proprietary to MediaTek Inc.
MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Postal address
No. 1, Dusing 1st Rd. , Hsinchu Science
Park, Hsinchu City, Taiwan 30078

MTK support office address

No. 1, Dusing 1st Rd. , Hsinchu Science
Park, Hsinchu City, Taiwan 30078

Internet
[Link]

Classification:Confidential B

2 V1.3 (2020-02-24)

PASTA Python APIs

 Document Revision History

Document Revision History

Revision Date Description

V1.0 2019-04-30 Initial release
V1.1 2019-05-31 Add device boot up function descriptions
MediaTek Confidential

V1.2 2019-11-14 Fix typo and update some API descriptions

V1.3 2020-02-24 Add proprietary c structure definitions API descriptions
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Classification:Confidential B

V1.3 (2020-02-24) 3

PASTA Python APIs

 Table of Contents

Table of Contents

Document Revision History.............................................................................................................................. 3

Table of Contents............................................................................................................................................. 4

MediaTek Confidential
1 Introduction .......................................................................................................................................... 7

1.1 Purpose ............................................................................................................................................. 7

1.2 Scope ................................................................................................................................................. 7

1.3 Conventions ...................................................................................................................................... 7

1.4 System Requirements ....................................................................................................................... 7

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

2 Abbreviations ........................................................................................................................................ 8
3 System Overview ................................................................................................................................... 9
4 Start PASTA ......................................................................................................................................... 10

This document contains information that is proprietary to MediaTek Inc.

4.1 Setup Environment ......................................................................................................................... 10

© 2019 - 2020 MediaTek Inc.

4.2 Release Materials ............................................................................................................................ 10

4.3 Boot up Device ................................................................................................................................ 12

4.3.1 boot_device(device, port, meta_console) .................................................................... 12

4.4 Prologue : Hello PASTA.................................................................................................................... 13

5 PastaContext Module .......................................................................................................................... 15

5.1 PastaContext Functions ................................................................................................................... 15

5.1.1 get_component(name) ................................................................................................. 15

5.1.2 set_component(name, component) ............................................................................. 15

5.1.3 get_property(name) ...................................................................................................... 16

Classification:Confidential B
5.1.4 set_property(name, property) ...................................................................................... 16

5.1.5 get_device_instance () .................................................................................................. 17

5.1.6 get_api_instance () ........................................................................................................ 17

5.1.7 get_codec_instance () ................................................................................................... 17

5.1.8 get_logger_instance () ................................................................................................... 18

5.1.9 create_shared_unit (name, module_name, class_name) ............................................. 18

5.1.10 get_shared_unit (name) ................................................................................................ 18

6 Device Module .................................................................................................................................... 20

6.1 Device Function ............................................................................................................................... 20

4 V1.3 (2020-02-24)

PASTA Python APIs

 Table of Contents

6.1.1 config(parameters) ........................................................................................................ 20

6.1.2 connect() ....................................................................................................................... 21

6.1.3 disconnect() ................................................................................................................... 21

6.1.4 send_command(type, data_buffer, data_buffer_size) ................................................. 21

MediaTek Confidential

6.1.5 get_modem_message(token, confirmation_id) ............................................................ 21

7 PastaApi Module ................................................................................................................................. 23

7.1 PastaApi Function............................................................................................................................ 23

7.1.1 get_transaction_api () ................................................................................................... 23

7.1.2 get_rftuning_api () ........................................................................................................ 23

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

7.2 TransactionApi Function ................................................................................................................. 24

7.2.1 create_ft_command(command_id, ft_structure, [union_structure], [data_buffer]) ... 24

This document contains information that is proprietary to MediaTek Inc.

7.2.2 send_modem_command(local_parameter, [peer_buffer]) .......................................... 25

7.2.3 get_ft_confirmation(token, confirmation_id, [timeout]).............................................. 25

© 2019 - 2020 MediaTek Inc.

7.2.4 create_rf_command(command_type, [union_structure], [data_buffer]) .................... 26

7.2.5 get_rf_confirmation(token, [timeout]) ......................................................................... 27

7.2.6 create_mmrf_command(command_type, [union_structure], [data_buffer]) .............. 28

7.2.7 get_mmrf_confirmation(token, [timeout]) ................................................................... 28

7.2.8 create_erf_command(command_type, [union_structure], [data_buffer]) .................. 29

7.2.9 get_erf_confirmation(token, [timeout]) ....................................................................... 29

7.2.10 create_nrf_command(command_type, [union_structure], [data_buffer]) .................. 30

7.2.11 get_nrf_confirmation .................................................................................................... 31

Classification:Confidential B

8 MessageCodecBuilder Module ............................................................................................................ 32

8.1 MessageCodecBuilder Function ...................................................................................................... 32

8.1.1 create(struct_name, [data_buffer]) .............................................................................. 32

8.1.2 fast_create(struct_name, union_name, [data_buffer]) ................................................ 33

8.1.3 add_structure(structure_definition) ............................................................................. 33

8.2 MessageCodec ................................................................................................................................ 34

8.2.1 list_members ................................................................................................................. 34

8.2.2 get_buffer() ................................................................................................................... 35

8.2.3 message data operator ................................................................................................. 35

9 Developing Samples ............................................................................................................................ 36

V1.3 (2020-02-24) 5

PASTA Python APIs

 MediaTek Confidential © 2019 - 2020 MediaTek Inc. Classification:Confidential B
This document contains information that is proprietary to MediaTek Inc.
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.
Table of Contents

Process Undefined DUT Commands and Responses ....................................................................... 36

V1.3 (2020-02-24)

PASTA Python APIs

9.1

6
 1 Introduction

1 Introduction

PASTA (Production-Line Automation Suite & Testing Architectures) is an application framework and a library
suite for developing MTK modem RF testing, calibration, tuning functions in Python language. The design
MediaTek Confidential

concepts of PASTA are focus on scalabilities, customizations and automation capabilities that achieved by
flexible software container architectures and facilitated APIs.

PASTA users can execute the META tool released RF python applications or develop customization features by
themselves.

1.1 Purpose
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

This document is intended to provide detailed information for the users would like to develop RF related scripting
applications using PASTA. It's a programming guide to make developers can quickly understand the capabilities
This document contains information that is proprietary to MediaTek Inc.

of PASTA.
© 2019 - 2020 MediaTek Inc.

1.2 Scope
This document describes detailed specifications of PASTA modules and APIs illusrated with sample code snippets.
The readers of this document are assumed to have relevant knowledge of MTK META tool and modem RF basic
concepts.

1.3 Conventions
The notation of API parameter with square brackets, e.g., [param] indicates optional parameter and can be
skipped. The parameter starts with asterisk, e.g., *values indicates an argument set (value1, value2, ...), each
Classification:Confidential B

value is separated by commas. Some functions need to specify name of parameter to assign correct parameter
value, such as function1(core=-1), which means set value -1 to the parameter core.

1.4 System Requirements

OS: Windows 7 above

Python 3.7-32bit (Nice to have): PASTA package contains an embedded python interpreter: [Link]
can launch python scripts, but we recommend PASTA script developers install Python3.7 for debugging
efficiencies. The [Link] can be found in the META_TOOL_FOLDER\Utilities\Pasta\bin folder.

V1.3 (2020-02-24) 7

PASTA Python APIs

 2 Abbreviations

2 Abbreviations

The abbreviations and their explanations used in this document are listed in the Table 2-1.

Table 2-1 Abbreviations

MediaTek Confidential
Abbreviations Explanation
PASTA Production-Line Automation Suite & Testing Architectures
META Mobile Engineering Testing Architecture
ILM Inter Layer Message
DUT Device Under Test

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Classification:Confidential B

8 V1.3 (2020-02-24)

PASTA Python APIs

 3 System Overview

3 System Overview

This chapter gives a brief introduction of PASTA software architectures shows as figure3.1. PASTA context is a
kernel component container that contains core features can be used by an application. The major functional
modules in a PASTA context include DUT communication module uses to connect to the device and doing data
MediaTek Confidential

transmission, the message codec module works for transaction commands encoding/decoding, the instrument
library module supports wrapped RF instruments controlling (very limited functions, we recommend users to
write the GPIB commands executed by python VISA module), the application interfaces enclose common usage
APIs, and the calibration & RF feature units are some META tool released functionality components.

Application
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

PASTA Context
Application Interfaces
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

DUT Communication Shared Modules Message Codec

Utilities
Instrument Library

Simulator

Fig 3-1 PASTA software architectures overview

Classification:Confidential B

PASTA Modules Quick Glance

import Pasta
context = Pasta.create_context () # create a runtime context
dut = context. get_device_instance () # get dut communication module
msg_codec = context. get_codec_instance () # get message codec instance
pasta_api = context. get_api_instance () # get common usage api
instrument = context. get_instrumentapi_instance () # get instrument control api
logger = context.get_get_logger_instance () # get tool logger instance

V1.3 (2020-02-24) 9

PASTA Python APIs

 4 Start PASTA

4 Start PASTA

The PASTA libraries and applications are delivered with META tool. All PASTA materials are kept in the
utilities/Pasta folder of the META tool package.

MediaTek Confidential
PASTA is implemented by Python3.7, we recommend users installing Python3.7 runtimes to setup
comprehensively development environments. But, if you don’t feel like to install new software, an embedded
python interpreter [Link] can be used as Python3.7 replacement.

The execution command is: Pasta/bin/[Link] [Link] arguments

Disclaimer:

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

If you have both Python2.x/3.x installation in your PC and intend to use [Link] as PASTA script runner, you
have to ascertain using the right Python 3.x interpreter for running PASTA script, e.g., py -3 [Link].

This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

4.1 Setup Environment
Please execute the [Link] under the PASTA root folder for the first time using PASTA, the “Install completely”
message will show up indicates successful installation. Without this setup step, you may encounter some
modules not found problem when develop or execute PASTA scripts.

Disclaimer:

PASTA requires VISA library to control RF instruments, for the users that already had Python3.7 installation and
not intend to using [Link] as script interpreter should install PyVisa library by yourselves. The PyVisa
installation command as:

pip install -U pyvisa

Classification:Confidential B
Disclaimer:

If you copy META tool (PASTA) package to preferred folder, you have to re-run [Link] under the new folder.

4.2 Release Materials

Figure 4.1 shows the release folder structures of PASTA, below are detailed introductions.

10 V1.3 (2020-02-24)

PASTA Python APIs

 4 Start PASTA
MediaTek Confidential
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Fig 4-1 PASTA release materials

APIs: PASTA API libraries

Applications: META tool released applications

Bin: Executable binaries

Codec: DUT transaction message encoder & decoder library

Database: The DUT communication data structure definition files

DUT: Target device communication library

Classification:Confidential B

Instrument: RF instrument controlling library

PastaContext: Application container library

Samples: Some sample scripts for reference

SharedModules: RF application related kernel modules

Documents: Helper documents

Utilities: Auxiliary libraries

V1.3 (2020-02-24) 11

PASTA Python APIs

 4 Start PASTA

4.3 Boot up Device

Normally, users manually boot up DUT into META mode before using PASTA to connect it. But, for some
automation applications, you might want to boot up the DUT by the code. The PASTA module provide a
boot_device function can support this function, there are several cases as below.

MediaTek Confidential
-----------------------------------------------------------------------------------------------------------------------------------------------

# boot up smartphone device using default path [Link] file and auto comport search

Pasta.boot_device()

-----------------------------------------------------------------------------------------------------------------------------------------------

# boot up smartphone device with specified comport

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Pasta.boot_device(port=14)

-----------------------------------------------------------------------------------------------------------------------------------------------

This document contains information that is proprietary to MediaTek Inc.

# boot up smartphone device by specified [Link] path

Pasta.boot_device(meta_console="YourMetaToolFolder\[Link]")

© 2019 - 2020 MediaTek Inc.

-----------------------------------------------------------------------------------------------------------------------------------------------

# boot up dongle(modem only) device with specified comport

Pasta.boot_device(device="md", port=14)

-----------------------------------------------------------------------------------------------------------------------------------------------

# boot up dongle(modem only) device by specified comport and [Link] path

Pasta.boot_device(device="md", port=14, "YourMetaToolFolder\[Link]")

-----------------------------------------------------------------------------------------------------------------------------------------------

4.3.1 boot_device(device, port, meta_console)

Boot up the testing target device Classification:Confidential B

Parameters

Name Type Description

device string Specify the device type. ‘sp’ for smartphone device and ‘md’ for dongle device.
Default value is ‘sp’
port int / string The device’s comport number or using ‘auto’ for auto comport search.
Default value is ‘auto’
meta_console string Meta console tool full path. Pasta use [Link] to boot up device. Skip
this parameter or set it to empty string indicates using default path.
Default value is empty string.

12 V1.3 (2020-02-24)

PASTA Python APIs

 4 Start PASTA

Disclaimer:

If you want to shut down the device after your script execution done, you can use adb command to do it. The
adb shutdown command is: [Link] shell reboot -p
MediaTek Confidential

4.4 Prologue : Hello PASTA

This chapter takes up a simple hello world example to illustrate users how to do DUT connection and get target
version information by PASTA.

import Pasta
# create a pasta runtime context
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

context = Pasta.create_context()
# connect to target device
This document contains information that is proprietary to MediaTek Inc.

dut = context.get_component("DUT_COMM_ENGINE")
[Link]("mode=usb;comport=auto")
© 2019 - 2020 MediaTek Inc.

connection_status = [Link]()
# get pasta module instances
pasta_api = context.get_api_instance ()
transaction = pasta_api.get_transaction_api()
codec = context. get_codec_instance()
# send version info query command to dut, and decode receiving data
FT_VER_INFO_REQ_ID, FT_VER_INFO_CNF_ID = 51, 52
# prepare command
token, command = transaction.create_ft_command(FT_VER_INFO_REQ_ID, "FT_VER_INFO_REQ")
# send command
transaction.send_modem_command(command.get_buffer())
# get confirmation
Classification:Confidential B

confirm = transaction.get_ft_confirmation(token, FT_VER_INFO_CNF_ID)

target_ver_info = [Link]("FT_VER_INFO_CNF", confirm['local'])
print (target_ver_info.SW_VER)

Detailed descriptions:

import Pasta

This is the first step of using PASTA, if you do not setup PASTA successfully, you might encounter something
wrong here.

context = Pasta.create_context()

V1.3 (2020-02-24) 13

PASTA Python APIs

 4 Start PASTA

Create a PASTA context, the context contains application based components and properties that can be
accessed in the whole execution cycle.

dut = context. get_device_instance ()

pasta_api = context. get_api_instance ()

MediaTek Confidential
codec = context. get_codec_instance ()

Get device connection, API, and message codec builder modules.

[Link]("mode=usb;comport=auto")

connection_status = [Link]()

Configure connection settings and connect to the device, now only USB connection is available.

token, command = transaction.create_ft_command(FT_VER_INFO_REQ_ID, "FT_VER_INFO_REQ")

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Create a command instance for setup command body. This API returns an identification token to match
device’s responses and a command encoding instance to fill values of command data members.

This document contains information that is proprietary to MediaTek Inc.

transaction.send_modem_command(command.get_buffer())

© 2019 - 2020 MediaTek Inc.

Send command to the target device

confirm = transaction.get_ft_confirmation(token, FT_VER_INFO_CNF_ID)

target_ver_info = [Link]("FT_VER_INFO_CNF", confirm['local'])

print (target_ver_info.SW_VER)

Get target confirmation that match request-command token and response id. Decode the received data then
show results.

Classification:Confidential B

14 V1.3 (2020-02-24)

PASTA Python APIs

 5 PastaContext Module

5 PastaContext Module

The design concept of PASTA context is similar to application container that creates an independent workspace
and establishes the connections between working components. The application can access registered
components and exchange data under the same context. An individual context represent a unique execution
MediaTek Confidential

environment, you can create multiple contexts for multitasking application.

Create a PASTA context such as:

import Pasta

context = Pasta.create_context()
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

5.1 PastaContext Functions

This document contains information that is proprietary to MediaTek Inc.

The detailed PastaContext APIs are described in the below sections.

© 2019 - 2020 MediaTek Inc.

5.1.1 get_component(name)
Returns the component of a specified name.

Parameters

Name Type Description

name string Unique component name as a key to index targeted component

Return
Classification:Confidential B

Returns a component instance or python None value if the specified component doesn’t exist.

Remarks

Component name is case sensitive.

5.1.2 set_component(name, component)

Add a functional component to the context with an identification name.

Parameters

V1.3 (2020-02-24) 15

PASTA Python APIs

 5 PastaContext Module

Name Type Description

name string An identification name of component
component object The instance of component

Remarks

MediaTek Confidential
You can add any python type of objects into context. If the specified name is existed in the context, the prior
component will be replaced by the new component.

Example
import configparser

context = Pasta.create_context()

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

my_parser = configparser .SafeConfigParser()

context.set_component(“ConfigFileParser”, my_parser)

This document contains information that is proprietary to MediaTek Inc.

…

registered_parser = context.get_component(“ConfigFileParser”)

© 2019 - 2020 MediaTek Inc.

5.1.3 get_property(name)
Gets the value of a specified property.

Parameters

Name Type Description

name string Property name to retrieve.

Classification:Confidential B
Return

Returns property value or "None" if the specified property is not exist.

Remarks

Property name is case sensitive.

5.1.4 set_property(name, property)

Add or modify a property of the context.

Parameters

16 V1.3 (2020-02-24)

PASTA Python APIs

 5 PastaContext Module

Name Type Description

name string An identification name of property
property object The value of property

Remarks
MediaTek Confidential

You can add any python type of objects as property. If the specified name is existed in the context, the prior
property will be replaced by new one.

The perspectives of PASTA context components and properties are different. Properties are assigned for the
application configurations and components are setup to achieve application’s functionalities.

5.1.5 get_device_instance ()
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Gets the device communication instance

This document contains information that is proprietary to MediaTek Inc.

Return
© 2019 - 2020 MediaTek Inc.

Returns the device module instance, same as calling get_component("DUT_COMM_ENGINE"). The detailed
descriptions of device module are addressed in the chapter 6.

5.1.6 get_api_instance ()
Gets the PastaApi instance

Return

Returns the PastaApi module instance same as calling get_component("PASTA_API "). The detailed descriptions
Classification:Confidential B

of PastaApi module are addressed in the chapter 7.

5.1.7 get_codec_instance ()
Gets the message codec builder instance

Return

Returns the MessageCodecBuilder module instance, same as calling:

get_component("MODEM_MESSAGE_CODEC_BUILDER"). The detailed descriptions of message codec builder

module are addressed in the chapter 8.

V1.3 (2020-02-24) 17

PASTA Python APIs

 5 PastaContext Module

5.1.8 get_logger_instance ()
Gets default context logging instance

Return

MediaTek Confidential
Returns the python logging object, same as calling get_component("PASTA_LOGGER").

5.1.9 create_shared_unit (name, module_name, class_name)

Create a META tool released shared modules.

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Parameters

Name Type Description

This document contains information that is proprietary to MediaTek Inc.

name string An identification name of created instance
module_name string The module(package) name that contains this calibration unit

© 2019 - 2020 MediaTek Inc.

class_name string The class name of calibration unit

Return

Returns the created instance. If failed to create; an exception will be raised.

Remarks

Shared unit is a strictly regulated functional class implemented and maintained by a PASTA development team
to provide some domain specific features, e.g., get RF capabilities, PA bias tuning, and the rest. Please consult
PASTA owners if you don’t have certain ideas of how to use it.

5.1.10 get_shared_unit (name) Classification:Confidential B

Get a created shared unit by name

Parameters

Name Type Description

name string An identification name of creation calibration instance

Return

Returns a created shared instance or python None value if the specified unit is not exist

18 V1.3 (2020-02-24)

PASTA Python APIs

 5 PastaContext Module

Remarks

Shared unit is a strictly regulated functional class implemented and maintained by a PASTA development team
to provide some domain specific features, e.g., get RF capabilities, PA bias tuning, and the rest. Please consult
PASTA owners if you don’t have certain ideas of how to use it.
MediaTek Confidential
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Classification:Confidential B

V1.3 (2020-02-24) 19

PASTA Python APIs

 6 Device Module

6 Device Module

The device module implements functions to connect to the target device and message transactions. You can get
device object as:

MediaTek Confidential
import Pasta

context = Pasta.create_context()

device = context. get_device_instance()

6.1 Device Function

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

The detailed device API information are described in the below sections.

This document contains information that is proprietary to MediaTek Inc.

6.1.1 config(parameters)

© 2019 - 2020 MediaTek Inc.

Setups configuration parameters for the device connection.

Parameters

Name Type Description

parameters String This parameter can include any combination of the supported connection attributes
concatenated by semicolon. Empty string means using the default settings.

Return

Returns 0 if doing configuration successfully.

Classification:Confidential B
Remarks

The notation of configuration parameter is: name1=value1;name2=value2;name3=value3…

e.g., [Link]("mode=usb;comport=auto").

The supported attributes and available values as:

attribute value Description

mode usb Connect to device via USB.
Other connection modes such as UART or XL1SIM is not supported yet.
comport auto Auto detect COM port number
1,2 ….. n Designated connection COM port number

20 V1.3 (2020-02-24)

PASTA Python APIs

 6 Device Module

6.1.2 connect()
Connects to the target device

Return
MediaTek Confidential

Returns 0 if connecte to device successfully

6.1.3 disconnect()
Disconnect the target connection
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Return

Returns 0 if disconnect the device successfully

This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

6.1.4 send_command(type, data_buffer, data_buffer_size)

Sends a command to the connection device

Parameters

Name Type Description

type integer Command type value, 0 indicates modem command and 1 for AP command
data_buffer bytes Command data buffer
data_buffer_size integer Size of command data buffer

Return
Classification:Confidential B

Returns 0 if sent command successfully.

Remarks

This is a low level API, users have to fully understand all details about command transaction protocols to compose
the precise binary data. We suggest not directly using this API to send command, using the transactional APIs is
much easier. Please refer to the chapter 7.2 for more details.

6.1.5 get_modem_message(token, confirmation_id)

Gets response message of the sending command from the DUT

V1.3 (2020-02-24) 21

PASTA Python APIs

 6 Device Module

Parameters

Name Type Description

token integer Serial number to match sending command
confirmation_id integer Confirmation number to identify interested message

MediaTek Confidential
Return

Returns a DutMessage object if found matched device’s message, or None object.

A DutMessage conatins attributes as below:

Name Type Description

src integer Source module number

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

dest integer Destination module number
sap integer Sap number
message_id integer Message identification number
localbuffer_size integer Local buffer data size

This document contains information that is proprietary to MediaTek Inc.

peerbuffer_size integer Peer buffer data size
localbuffer byte array Local buffer byte array object
peerbuffer byte array Peer buffer byte array object

© 2019 - 2020 MediaTek Inc.

message string Decoded text

Remarks

This is a low level API of getting response from the DUT. We suggest not directly using this API to retrieve target
confirmations, using the transactional APIs is much easier. Please refer to the chapter 7.2 for more details.

Classification:Confidential B

22 V1.3 (2020-02-24)

PASTA Python APIs

 7 PastaApi Module

7 PastaApi Module

PastaApi is the key module of PASTA framework provides high level APIs to process message codec, transaction
management, and feature level composition functions. You can get PastaApi object as:
MediaTek Confidential

import Pasta

context = Pasta.create_context()

pasta_api = context. get_api_instance ()

7.1 PastaApi Function

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

According to the functionalities, PASTA provides multiple sub API interfaces, call the accessing function to get the
interested interface.
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

7.1.1 get_transaction_api ()
Get transaction api instance. Transaction api class performs working functions to complete ‘business’ between
application and target device.

Return

Returns a transaction api object.

7.1.2 get_rftuning_api ()
Classification:Confidential B

Get rftuning api instance. Rftuning api class performs high level RF performance tuning oriented functions.

Return

Returns a rftuning api object.

Remarks

This document does not contain descriptions of RF tuning APIs.

V1.3 (2020-02-24) 23

PASTA Python APIs

 7 PastaApi Module

7.2 TransactionApi Function

The detailed transaction API information are described in the below sections.

7.2.1 create_ft_command(command_id, ft_structure, [union_structure],

MediaTek Confidential
[data_buffer])
Creates a transactional command object to communicate with FT task running on the target device. FT command
is the based type of other radio access technology(RAT) specified commands.

Parameters

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Name Type Description
command_id integer Specifies the command id number to be sent.
ft_structure string Specifies the corresponded command structure name

This document contains information that is proprietary to MediaTek Inc.

union_structure string [Optional] Specifies type-name of union member in FT command structure to improve
execution performance
data_buffer byte array [Optional] Sets data buffer to initialize this FT command. The command structure

© 2019 - 2020 MediaTek Inc.

members will be filled corresponded value gets from data buffer.

Return

Returns an integer value to represent serial number (token) of this transaction and a command codec object can
be used to assign values of command structure members.

Remarks

The FT command IDs and corresponded structure definitions are designed by L1 protocol team as communication
specifications. PASTA users may need to consult L1 experts to get precise command settings.

Classification:Confidential B
Example
import Pasta
context = Pasta.create_context() # create a runtime context
… # skip some connection flows
pasta_api = context.get_api_instance () # get pasta api
transaction = pasta_api.get_transaction_api() # get transaction api object
# create a FT command for locking down NVRAM
FT_NVRAM_LOCK_REQ_ID = 21

token, command = transaction.create_ft_command(FT_NVRAM_LOCK_REQ_ID, "FT_NVRAM_LOCK_REQ")

command. lock_en = 3 # set lock bitmap

transaction.send_modem_command(command.get_buffer()) # send command to the target

24 V1.3 (2020-02-24)

PASTA Python APIs

 7 PastaApi Module

FT_NVRAM_LOCK_CNF_ID = 20

confirm = transaction.get_ft_confirmation(token, FT_NVRAM_LOCK_CNF_ID) # get target response matches command token and
confirmation id

7.2.2 send_modem_command(local_parameter, [peer_buffer])

MediaTek Confidential

Sends modem command to the connection target device.

Parameters

Name Type Description

local_parameter byte array Local parameter data buffer.
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

peer_buffer byte array [Optional] Peer buffer data buffer.

Return
This document contains information that is proprietary to MediaTek Inc.

Returns True for successful sending command otherwise return False.

© 2019 - 2020 MediaTek Inc.

Remarks

Based on modem message communication protocol: Inter Layer Message (ILM), there are two parts of
transaction data: local parameter and peer buffer. The local parameter contains mandatory communication data,
and the optional peer buffer uses to exchange massive private data.

7.2.3 get_ft_confirmation(token, confirmation_id, [timeout])

Gets target response message aligned with designated message id and transaction serial number(token).
Classification:Confidential B

Parameters

Name Type Description

token integer The transaction number from a previous creation function
confirmation_id integer The FT_TASK communication message id
timeout integer [Optional] The time-out interval, in milliseconds. Default value is 3000 ms.

Return

Returns a DutConfirmation object, its attributes include:

name Value type Description

status integer 0: successfully gets designated message. 1: timeout
local byte array Local parameter data buffer
peer byte array Peer buffer data buffer
rf_response PrimitiveData Should be None

V1.3 (2020-02-24) 25

PASTA Python APIs

 7 PastaApi Module

name Value type Description

mmrf_response PrimitiveData Should be None
erf_response PrimitiveData Should be None
nrf_response PrimitiveData Should be None

MediaTek Confidential
Example

Please refer to the example in the chapter 7.2.1 create_ft_command

7.2.4 create_rf_command(command_type, [union_structure], [data_buffer])

Creates an object of pre-categorized 'RF_TEST_REQ' transaction command.

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

This document contains information that is proprietary to MediaTek Inc.
Parameters

Name Type Description

© 2019 - 2020 MediaTek Inc.

command_type integer The command type value
union_structure string [Optional] Specifies type-name of union member in RF_TEST_REQ command structure
to improve execution performance
data_buffer byte array [Optional] Sets data buffer to initialize this RF_TEST_REQ command. The command
structure members will be filled corresponded value gets from data buffer.

Return

Returns an integer value to represent serial number(token) of this transaction and a 'RF_TEST_REQ' command
codec object can be used to assign values of command structure members.

Remarks

Classification:Confidential B
The command_type argument is an identification number to determine the practical execution command in the
'RF_TEST_REQ' category. Each command_type has its data placeholder union member, without giving an explicit
union structure name, system will extend all available unions and take more time.

The command type number and corresponded structure definitions are designed by L1 protocol team as
communication specifications. PASTA users may need to consult L1 experts to get precise command settings.

Example
import Pasta

context = Pasta.create_context()

dut = context. get_device_instance()

26 V1.3 (2020-02-24)

PASTA Python APIs

 7 PastaApi Module

[Link]("mode=usb;comport=auto")

connect_result = [Link]()

api = context. get_api_instance()

transaction = api.get_transaction_api()
MediaTek Confidential

codec = context. get_codec_instance()

RF_TEST_CMD_GET_RFID = 20

# create a rf command with command type 20 and skip union parameter

token, rf_command = transaction.create_rf_command(RF_TEST_CMD_GET_RFID, "IGNORE")

transaction.send_modem_command(rf_command.get_buffer())
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

dut_confirm = transaction.get_rf_confirmation(token) # get confirmation

if dut_confirm.status == 0:
This document contains information that is proprietary to MediaTek Inc.

print(dut_confirm.rf_response.[Link]) # print RF id
© 2019 - 2020 MediaTek Inc.

7.2.5 get_rf_confirmation(token, [timeout])

Gets target response message aligned with specific message id(RF_TEST_CNF) and transaction serial
number(token).

Parameters

Name Type Description

token integer The value to identify transaction
timeout integer [Optional] The time-out interval, in milliseconds. Default value is 3000 ms.
Classification:Confidential B

Return

Returns a DutConfirmation object, its attributes include:

name Value type Description

status integer 0: successfully gets designated message. 1: timeout
local byte array Local parameter data buffer
peer byte array Peer buffer data buffer
rf_response PrimitiveData The 'FT_RF_TEST_CNF' structure codec object
mmrf_response PrimitiveData Should be None
erf_response PrimitiveData Should be None
nrf_response PrimitiveData Should be None

Example

Please refer to the example of ceate_rf_command

V1.3 (2020-02-24) 27

PASTA Python APIs

 7 PastaApi Module

7.2.6 create_mmrf_command(command_type, [union_structure], [data_buffer])

Creates an object of pre-categorized 'MMRF_TEST_REQ' transaction command.

MediaTek Confidential
Parameters

Name Type Description

command_type integer The command type value
union_structure string [Optional] Specifies type-name of union member in MMRF_TEST_REQ command
structure to improve execution performance
data_buffer byte array [Optional] Sets data buffer to initialize this MMRF_TEST_REQ command. The
command structure members will be filled corresponded value gets from data buffer.

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Return

This document contains information that is proprietary to MediaTek Inc.

Returns an integer value to represent serial number(token) of this transaction and a 'MMRF_TEST_REQ'
command codec object can be used to assign values of command structure members.

© 2019 - 2020 MediaTek Inc.

Remarks

The command_type argument is an identification number to determine the practical execution command in the
'MMRF_TEST_REQ ' category. Each command_type has its data settlement union member, without giving an
explicit union structure name, system will extend all available unions and take more time.

The command type number and corresponded structure definitions are designed by L1 protocol team as
communication specifications. PASTA users may need to consult L1 experts to get precise command settings.

Classification:Confidential B
7.2.7 get_mmrf_confirmation(token, [timeout])
Gets target response message aligned with specific message id (MMRF_TEST_CNF) and transaction serial
number(token).

Parameters

Name Type Description

token integer The value to identify transaction
timeout integer [Optional] The time-out interval, in milliseconds. Default value is 3000 ms.

Return

Returns a DutConfirmation object, its attributes include:

28 V1.3 (2020-02-24)

PASTA Python APIs

 7 PastaApi Module

name Value type Description

status integer 0: successfully gets designated message. 1: timeout
local byte array Local parameter data buffer
peer byte array Peer buffer data buffer
rf_response PrimitiveData Should be None
mmrf_response PrimitiveData The 'FT_MMRF_TEST_CNF' structure codec object
erf_response PrimitiveData Should be None
nrf_response PrimitiveData Should be None
MediaTek Confidential

7.2.8 create_erf_command(command_type, [union_structure], [data_buffer])

Creates an object of pre-categorized 'ERF_TEST_REQ' transaction command.
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Parameters

Name Type Description

This document contains information that is proprietary to MediaTek Inc.

command_type integer The command type value

union_structure string [Optional] Specifies type-name of union member in ERF_TEST_REQ command
structure to improve execution performance
© 2019 - 2020 MediaTek Inc.

data_buffer byte array [Optional] Sets data buffer to initialize this ERF_TEST_REQ command. The command
structure members will be filled corresponded value gets from data buffer.

Return

Returns an integer value to represent serial number(token) of this transaction and a 'ERF_TEST_REQ' command
codec object can be used to assign values of command structure members.

Remarks

The command_type argument is an identification number to determine the practical execution command in the
'ERF_TEST_REQ ' category. Each command_type has its data settlement union member, without giving an explicit
Classification:Confidential B

union structure name, system will extend all available unions and take more time.

The command type number and corresponded structure definitions are designed by L1 protocol team as
communication specifications. PASTA users may need to consult L1 experts to get precise command settings.

7.2.9 get_erf_confirmation(token, [timeout])

Gets target response message aligned with specific message id(ERF_TEST_CNF) and transaction serial
number(token).

Parameters

V1.3 (2020-02-24) 29

PASTA Python APIs

 7 PastaApi Module

Name Type Description

token integer The value to identify transaction
timeout integer [Optional] The time-out interval, in milliseconds. Default value is 3000 ms.

Return

MediaTek Confidential
Returns a DutConfirmation object, its attributes include:

name Value type Description

status integer 0: successfully gets designated message. 1: timeout
local byte array Local parameter data buffer
peer byte array Peer buffer data buffer
rf_response PrimitiveData Should be None
mmrf_response byte array Should be None
erf_response byte array The 'FT_ERF_TEST_CNF' structure codec object
nrf_response byte array Should be None

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

7.2.10 create_nrf_command(command_type, [union_structure], [data_buffer])

This document contains information that is proprietary to MediaTek Inc.

Creates an object of pre-categorized 'NRF_TEST_REQ' transaction command.

© 2019 - 2020 MediaTek Inc.

Parameters

Name Type Description

command_type integer The command type value
union_structure string [Optional] Specifies type-name of union member in NRF_TEST_REQ command
structure to improve execution performance
data_buffer byte array [Optional] Sets data buffer to initialize this NRF_TEST_REQ command. The command
structure members will be filled corresponded value gets from data buffer.

Return

Returns an integer value to represent serial number(token) of this transaction and a 'NRF_TEST_REQ' command

Classification:Confidential B
codec object can be used to assign values of command structure members.

Remarks

The command_type argument is an identification number to determine the practical execution command in the
'NRF_TEST_REQ ' category. Each command_type has its data settlement union member, without giving an explicit
union structure name, system will extend all available unions and take more time.

The command type number and corresponded structure definitions are designed by L1 protocol team as
communication specifications. PASTA users may need to consult L1 experts to get precise command settings.

30 V1.3 (2020-02-24)

PASTA Python APIs

 7 PastaApi Module

7.2.11 get_nrf_confirmation
Gets target response message aligned with specific message id(NRF_TEST_CNF) and transaction serial
number(token).
MediaTek Confidential

Parameters

Name Type Description

token integer The value to identify transaction
timeout integer [Optional] The time-out interval, in milliseconds. Default value is 3000 ms.

Return

Returns a DutConfirmation object, its attributes include:

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

name Value type Description

status integer 0: successfully gets designated message. 1: timeout
This document contains information that is proprietary to MediaTek Inc.

local byte array Local parameter data buffer

peer byte array Peer buffer data buffer
rf_response PrimitiveData Should be None
© 2019 - 2020 MediaTek Inc.

mmrf_response byte array Should be None

erf_response byte array Should be None
nrf_response byte array The 'FT_NRF_TEST_CNF' structure codec object
Classification:Confidential B

V1.3 (2020-02-24) 31

PASTA Python APIs

 8 MessageCodecBuilder Module

8 MessageCodecBuilder Module

This module provides functions to create message codec objects with specified structure name. The codec object
can be used to compose binary data sent to target, and decompose binary data into structure members came
from target. You can get codec builder object as:

MediaTek Confidential
import Pasta

context = Pasta.create_context()

codec = context. get_codec_instance()

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

8.1 MessageCodecBuilder Function
The detailed MessageCodecBuilder API information are described in the below sections.

This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

8.1.1 create(struct_name, [data_buffer])
Creates a C structure alike representative codec object

Parameters

Name Type Description

structure_name string The precise structure name defined in the database.
data_buffer byte array [Optional] Sets data buffer to initialize this structure.

Return

Returns a MessageCodec object or python None if the structure name cannot be found in the database.

Classification:Confidential B
Remarks

The functions of MessageCodec object are described in the section 8.2.

Example
import Pasta

context = Pasta.create_context() #create a pasta context

codec = context. get_codec_instance () #get codec object

pusch_tx_command = [Link]("ERfTestCmdPuschTx") #create a ERfTestCmdPuschTx codec object

members = pusch_tx_command.list_members() # list all structure members

32 V1.3 (2020-02-24)

PASTA Python APIs

 8 MessageCodecBuilder Module

8.1.2 fast_create(struct_name, union_name, [data_buffer])

Creates a C structure alike representative codec object with the specified union member type.
MediaTek Confidential

Parameters

Name Type Description

structure_name string The precise structure name defined in the database.
union_name string Specifies type-name of the first union member defined in the structure to improve
performance
data_buffer byte array [Optional] Sets data buffer to initialize this structure.
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Return

Returns a MessageCodec object or python None if the structure name cannot be found in the database.
This document contains information that is proprietary to MediaTek Inc.

© 2019 - 2020 MediaTek Inc.

Remarks

This API is designed to improve the creation performace of some fixed format structures that have a union
member, such as FT_RF_TEST_REQ , FT_RF_TEST_CNF, FT_ERF_TEST_REQ, FT_ERF_TEST_CNF, and so on.

The functions of MessageCodec object are described in the section 8.2.

8.1.3 add_structure(structure_definition)
Adds proprietary C structure definitions into the Pasta database, and can be used to create the representative
codec object
Classification:Confidential B

Parameters

Name Type Description

structure_definition string Limited C structure definitions.

Remarks

This API is designed for processing proprietary DUT commands and responses that are not defined in the PASTA
database. Not all C structures syntaxes are supported, such as union and pointer, etc. Please refer to the section
9.1 for the detailed usage example.

V1.3 (2020-02-24) 33

PASTA Python APIs

 8 MessageCodecBuilder Module

8.2 MessageCodec
MessageCodec is an abstraction class that can ship any types of structure defined in the database file. Developers
can access structure’s data members as normally read/write its attributes using the intuitive operator ".".
import Pasta

MediaTek Confidential
context = Pasta.create_context() # create a pasta context

codec = context. get_codec_instance () # get codec object

pusch_tx_command = [Link]("ERfTestCmdPuschTx") # create a ERfTestCmdPuschTx codec object

pusch_tx_command.band = 10 # assign value to structure’s data member

new_band = pusch_tx_command.band + 5 # access value of structure’s data member

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

The detailed MessageCodec API information are described in the below sections

This document contains information that is proprietary to MediaTek Inc.

8.2.1 list_members

© 2019 - 2020 MediaTek Inc.

Shows all data members of this MessageCodec object.

Return

A string object contains all member’s data-type and field-name info.

Remarks

It’s difficult to figure out precise member’s name of a coding structure. This API can enumerate all child members
of MessageCodec object to alleviate development efforts.

Classification:Confidential B
Example
import Pasta

context = Pasta.create_context() # create a pasta context

codec = context. get_codec_instance() # get codec object

pusch_tx_command = [Link]("ERfTestCmdPuschTx") # create a ERfTestCmdPuschTx codec object

member_info = pusch_tx_command.list_members() # get all data members of structure ERfTestCmdPuschTx

print (member_info)

--- You cane see something outputs as below ----

unsigned char band

unsigned char duplexMode

unsigned char tddConfig

34 V1.3 (2020-02-24)

PASTA Python APIs

 8 MessageCodecBuilder Module

8.2.2 get_buffer()
Gets binary data of this MessageCodec object
MediaTek Confidential

Return

Returns a Python byte array object that contains its structure member values

8.2.3 message data operator

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Gets or sets message structure member values

This document contains information that is proprietary to MediaTek Inc.

Remarks
© 2019 - 2020 MediaTek Inc.

To access structure’s data members you can use Python class-attribute reference operator "." to get things done.
System will investigate data type of accessing member to guarantee the integrities of message data, an exception
will be raised if it finds invalid data type of value assignment.

No differences for accessing nested structure(structure contains child structure member), each structure type
member can be seen as an individual MessageCodec object has the same capabilities.

Example
import Pasta

context = Pasta.create_context() #create a pasta context

codec = context. get_codec_instance () #get codec object

Classification:Confidential B

nrf_command = [Link]("FT_NRF_TEST_REQ") #create a ERfTestCmdPuschTx codec object

nrf_command.[Link] = 1 # assign value to the grandchild member token

nrf_command.type = 10

nrf_command.param.trx_updt. opMode = 2 # assign value to the union type member

V1.3 (2020-02-24) 35

PASTA Python APIs

 9 Developing Samples

9 Developing Samples

This section provides some practical samples to help users dealing some common problems.

MediaTek Confidential
9.1 Process Undefined DUT Commands and Responses
Protocol users might want to verify some under developing commands and messages via Pasta. They will struggle
with how to add these new data structures into Pasta.

Pasta supports adding proprietary c-structure definitions in the user’s Python scripts, and can create
corresponded representative objects for processing DUT transactions.

Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Step1: Define your c-structures in the Python script as below example

This document contains information that is proprietary to MediaTek Inc.

import Pasta

© 2019 - 2020 MediaTek Inc.

# declare your command c-structures
MY_COMMAND_STRUCT_DEFINITION = """
struct REQUEST_DATA
{
kal_uint16 mipi_addr;
kal_uint16 mipi_data; // mipi data
};
struct MY_REQUEST
{
struct REQUEST_DATA data[5];
};

Classification:Confidential B
struct MY_RESPONSE
{
kal_uint32 result;
kal_uint8 band;
kal_uint16 frequency;
};
"""

context = Pasta.create_context()
codec = context.get_codec_instance()
codec.add_structure(MY_COMMAND_STRUCT_DEFINITION)

36 V1.3 (2020-02-24)

PASTA Python APIs

 9 Developing Samples

Step2: Create a representative object to compose your DUT command

# prepare request command object

request = [Link]("MY_REQUEST")
[Link][0].mipi_addr = 12
MediaTek Confidential

[Link][0].mipi_data = 23
[Link][1].mipi_addr = 100
# .... assign other data ...
# print out the composed data for debugging
print(' '.join('{:02x}'.format(x) for x in request.get_buffer()))
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.

Step3: Create a representative object to decode DUT’s response

# parse received confirmation data

This document contains information that is proprietary to MediaTek Inc.

simulated_received_data = b'\x01\x00\x00\x00\x0A\x00\xA1\x00' # result = 1 , band = 10, frequency = 161

response = [Link]("MY_RESPONSE", simulated_received_data)
© 2019 - 2020 MediaTek Inc.

print ("result = ", [Link])

print ("band = ", [Link])
print ([Link])
Classification:Confidential B

V1.3 (2020-02-24) 37

PASTA Python APIs