R31DS0087EU0101 Rev.1.01

Page 23

Sep.28.21

pcm4l Datasheet

4. PTP Clock Manager Management

4.1 Management APIs

The Renesas servo management API reference describes all C functions, types and definitions of the application

programming interface to access and configure the Renesas servo software. Complete details can be found in

“Servo Management API” of the PCM4L Reference Manual.

However, pcm4l is meant to be a stand-alone, user-space application. For this reason, it is recommend to refer to

the provided Management CLI Utility. The management interface's server IP address is configurable through

JSON parameter: mgmtIpAddress.

4.2 Management CLI Utility

The Renesas PTP Clock Manager software includes a command line interface (CLI) utility for management. It

provides an interactive interface for user to enter management command code and displays the response from

server.

The CLI executable is compiled as “cliClient”. It has the following syntax:

cliClient <server IP address> <server port number>

After CLI successfully connects to the server, type “help” from the command prompt to display all the supported

management codes. To see help text for each individual command, type “help <command code>”:

>help 05

Get the Holdover Type: Software or Hardware

>help 06

Set the Holdover Type: Software = 0, else Hardware

minOutlierThresholdNanose

conds

100

Any offset from master calculation determined to be greater than this in

nanoseconds will be identified as an outlier.

minOutlierCountThreshold

16

Number of sequential outliers before discarding phase offset adjustments.

Table 12. Reference Tracker Configuration Parameters (Cont.)

JSON Identifier

Default

Description