This document provides a brief description of the ptptc OpEN APIs. It provides the following services:

Check if the PTP TC is supported.
Check if the unit is valid for PTP TC.
Get PTP TC admin mode.
Set PTP TC admin mode.
Determine if interface configuration can be applied in hardware.
Get PTP TC mode on the specified interface.
Gets PTP TC operational mode on the specified interface.
Check if the interface is valid for PTP TC.

Example C Application ptptc_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

ptptc_example

ptptc_example.c is a sample application that demonstrates the use of OpEN's ptptc APIs. ptptc_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

Usage: ./ptptc_example <test#> <arg1> <arg2> ...
Test 1: Check if the PTP TC is supported: ptptc_example 1
Test 2: Check if the unit is valid for PTP TC: ptptc_example 2 <unit>
Test 3: Get PTP TC admin mode: ptptc_example 3 <adminMode>
Test 4: Set PTP TC admin mode: ptptc_example 4 <adminMode>
Test 5: Determine if interface configuration can be applied in hardware: ptptc_example 5 <intfNum><isAllowed>
Test 6: Get PTP TC mode on the specified interface: ptptc_example 6 <intfNum><adminMode>
Test 7: Gets PTP TC operational mode on the specified interface: ptptc_example 7 <intfNum><mode>
Test 8: Check if the interface is valid for PTP TC: ptptc_example 8 <intfNum><isValid>
Test 9: Run API sanity checks: ptptc_example 9

ptptc CLI/API Cross Reference

PTP TC CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# [no] ptp clock e2e-transparent	openapiPtpTcIsSupportedGet() openapiPtpTcIsValidUnitGet() openapiPtpTcAdminModeGet() iopenapiPtpTcAdminModeSet() openapiPtpTcIntfHwConfigAllowedGet() openapiPtpTcIntfAdminModeGet() openapiPtpTcIntfOperAdminModeGet()

Broadcom reserves the right to make changes without further notice to any products or data herein to improve reliability, function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom does not assume any liability arising out of the application or use of this information, nor the application or use of any product or circuit described herein, neither does it convey any license under its patent rights nor the rights of others.