R31DS0087EU0101 Rev.1.01

Page 17

Sep.28.21

pcm4l Datasheet

The master can be unlocked by calling mngApi_SetG82651MasterLockoutEnable with the corresponding

instance number and lockoutEnable set to E_osFalse.

The lock acquisition timer is configured by the JSON parameter qualificationTimeoutSeconds.

3. Start-up System Configuration

This section describes the format and method of configuring PCM application start-up. This includes details on the

configuration file format, configuration file verification, configuration file processing, and information about the

configuration parameters themselves.

3.1 The JavaScript Object Notation (JSON)

Renesas uses the JavaScript Object Notation (JSON) text notation to configure the pcm4l. JSON is a text based,

lightweight data interchange format. The JSON configuration file contains a set of configurable parameters that

provides the user with the flexibility to configure the operation of their 1588 implementation.

The JSON Configuration file and associated scripts, files and tools can be found in the idtBuild\idtConfig\ directory.

3.1.1

JSON Configuration File

The JSON configuration file is provided in ASCII formatted text, and can be easily edited using any text editor. A

JSON formatted file is recognizable by the .json file type. The JSON configuration file conventions are as follows:

▪ The JSON array starts with ‘[‘ (left bracket) and ends with ‘]’ (right bracket).

▪ A JSON object consists of an unordered set of name/value pairs. The JSON object starts with ‘{‘ (left brace) and

ends with ‘}’ (right brace).

▪ Each name is separated from its value by a ‘:’ (colon) and the name/value pairs are separated by a ‘,’ (comma).

▪ The name is represented by a “string” while the value can be represented by a string in double quotes, a

number, another JSON object, a JSON array or a true, false or null keyword.

▪ The JSON object name “_description_” is used for comments and the value is not used.

3.2 General Configuration Parameters

The following configuration parameters can be specified in the JSON Configuration file. Default values are

populated for any configuration item not present in the JSON configuration file.

Table 2. Top-Level Configuration Parameters

JSON Identifier

Default

Description

versionId

“4.0”

Identifies the version of software that the configuration file is compatible with.

Every configuration file must indicate the version of software the configuration

file corresponds to. This field should not be changed unless migrating a

configuration file from one version of software to another.

testModeEnable

0

Test mode. When test mode is enabled, data validation errors are ignored.

0 = Disabled, errors flagged and application exits.

1 = Enabled, errors flagged and application continues.

referenceTrackerType

“AdaptiveTime” Selects the type of reference tracker to be used by the application (see

Reference Trackers (RTs)).

▪ “AdaptiveFrequency”: See Assisted Time Reference Tracker.

▪ “AdaptiveTime”: See Adaptive Time Reference Tracker.

▪ “WritePhase”: See Write Phase Reference Tracker

mgmtIpAddress

“127.0.0.1”

IPv4 address used by the application management interface.